Merge branch 'staging' into roadmap

georgia-tech-db · Oct 25, 2023 · 482097e · 482097e
2 parents 6af77d2 + 703dc94
commit 482097e
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 4 deletions.
diff --git a/docs/source/overview/connect-to-data-sources.rst b/docs/source/overview/connect-to-data-sources.rst
@@ -6,7 +6,7 @@ EvaDB supports a wide range of data sources including SQL database systems, obje
 Connect to an Existing SQL Database System
 ------------------------------------------
 
-1. Use the :ref:`CREATE DATABASE<create-database>` statement to connect to an **existing** SQL database.
+1. Use the :ref:`CREATE DATABASE<create-database>` statement to connect to an **existing** SQL database server. For example, here is the SQL command to connect EvaDB with a locally running :ref:`PostgreSQL<postgresql>` database server running on port ``5432``.
 
 .. code-block::
 
@@ -20,10 +20,21 @@ Connect to an Existing SQL Database System
        "database": "restaurant_reviews"
    };
 
+For quick prototyping, you can use an embedded :ref:`SQLite<sqlite>` database. Here, the SQLite database file is called ``evadb.db``.
+
+.. code-block::
+
+   CREATE DATABASE restaurant_reviews 
+   WITH ENGINE = 'sqlite', 
+   PARAMETERS = {
+       "database": "evadb.db"
+   };
+
 .. note::
 
    Go over the :ref:`CREATE DATABASE<create-database>` statement for more details. The :ref:`Databases<databases>` page lists all the database systems that EvaDB currently supports.
 
+
 2. Preview the data using ``SELECT``
 
 You can now preview the data stored in the ``food_review`` table in the ``restaurant_reviews`` database with a :ref:`SELECT<select>` statement.
@@ -82,6 +93,6 @@ You can use the ``CREATE INDEX`` statement to connect to an existing vector data
 
 .. note::
 
-   Go over the :ref:`CREATE INDEX<create-index>` statement for more details. The :ref:`Vector Databases<databases>` page lists all the vector database systems that EvaDB currently supports.
+   Go over the :ref:`CREATE INDEX<create-index>` statement for more details. The :ref:`Vector Databases<vector_databases>` page lists all the vector database systems that EvaDB currently supports.
 
 .. include:: ../shared/designs/design3.rst
diff --git a/docs/source/reference/databases/postgres.rst b/docs/source/reference/databases/postgres.rst
@@ -1,3 +1,5 @@
+.. _postgresql:
+
 PostgreSQL
 ==========
 

diff --git a/docs/source/reference/databases/sqlite.rst b/docs/source/reference/databases/sqlite.rst
@@ -1,3 +1,5 @@
+.. _sqlite:
+
 SQLite
 ==========
 
@@ -16,7 +18,7 @@ Required:
 
 * `database` is the path to the database file to be opened. You can pass ":memory:" to create an SQLite database existing only in memory, and open a connection to it.
 
-.. warning:: 
+.. note:: 
 
      If the ``database`` parameter is specified, EvaDB connects to the already existing ``sqlite`` database specified. Otherwise, it automatically creates a new ``sqlite`` database named ``evadb.db``.
 

diff --git a/docs/source/reference/evaql.rst b/docs/source/reference/evaql.rst
@@ -1,3 +1,5 @@
+.. _evaql:
+
 EvaDB Query Language (EvaQL)
 ============================
 

diff --git a/docs/source/shared/postgresql.rst b/docs/source/shared/postgresql.rst
@@ -1,7 +1,12 @@
 Connect EvaDB to PostgreSQL Database Server
 -------------------------------------------
 
-We will assume that you have a ``PostgreSQL`` database server running locally that contains the data needed for analysis. Follow these instructions to install `PostgreSQL <https://www.postgresql.org/download/>`_.
+We will assume that you have a :ref:`PostgreSQL<postgresql>` database running locally that contains the data needed for analysis. Follow these instructions to install `PostgreSQL <https://www.postgresql.org/download/>`_. 
+
+.. note::
+    If find it challenging to install the ``PostgreSQL`` database on your machine, here is an alternative for quick prototyping. 
+
+    You can use an embedded :ref:`SQLite<sqlite>` database. If you go with the ``sqlite`` database, alter the SQL commands in this tutorial to use the ``sqlite`` engine and the ``evadb.db`` SQLite database file as explained in the :ref:`SQLite<sqlite>` page.
 
 EvaDB lets you connect to your favorite databases, data warehouses, data lakes, etc., via the ``CREATE DATABASE`` statement. In this query, we connect EvaDB to an existing ``PostgreSQL`` server: