Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add mysql as an available data source into documentation #1025

Merged
merged 3 commits into from
Sep 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ parts:
title: Data Sources
sections:
- file: source/reference/databases/postgres
- file: source/reference/databases/mysql

- file: source/reference/udfs/index
title: Models
Expand Down
2 changes: 1 addition & 1 deletion docs/source/dev-guide/contribute/setup-dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ After installing the package locally, you can make changes and run the test case
.. note::

EvaDB provides multiple installation options for extending its functionalities.
Please see :ref:`installation guide` for all options.
Please see :ref:`installation options` for all options.

Other options can be installed with the ``dev`` environment.

Expand Down
7 changes: 7 additions & 0 deletions docs/source/dev-guide/extend/new-data-source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,10 @@ Add your created data source handler in `get_database_handler` function at `evad
return mod.MydbHandler(engine, **kwargs)
...

Add the Data Source in Documentation
------------------------------------

Add your new data source into :ref:`databases` section for reference.

- Create ``mydb.rst`` under `evadb/docs/source/reference/databases <https://github.com/georgia-tech-db/evadb/tree/staging/docs/source/reference/databases>` directory. You can refer to the existing documentation under the directory for example information to be covered in ``mydb.rst``.
- Update ``source/reference/databases/postgres`` in `evadb/docs/_toc.yml <https://github.com/georgia-tech-db/evadb/blob/staging/docs/_toc.yml>`.
5 changes: 0 additions & 5 deletions docs/source/overview/connect-to-database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ Connect to Database

EvaDB supports an extensive range of data sources for structured and unstructured data.

.. note::

Learn more about structured and unstructured data in :doc:`Data Sources <getting-started/data-sources>`.


Connect to a SQL Database System
--------------------------------

Expand Down
3 changes: 2 additions & 1 deletion docs/source/overview/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Now, activate the virtual environment:
You should see a list of installed packages including but not limited to the following:

.. code-block:: bash

Package Version
----------------- -------
aenum 3.1.15
Expand Down Expand Up @@ -133,4 +134,4 @@ Try out EvaDB by experimenting with the introductory `MNIST notebook on Colab <h
.. image:: ../../images/reference/mnist.png

.. note::
Go over the :ref:`Python API<python-api>` to learn more about the functions used in this app.
Go over the :ref:`Python API<python-api>` to learn more about the functions used in this app.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _installation options:

Installation Options
==================
====================

EvaDB provides the following additional installation options for extending its functionality.

Expand Down
36 changes: 36 additions & 0 deletions docs/source/reference/databases/mysql.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
MySQL
==========

The connection to MySQL is based on the `mysql-connector-python <https://pypi.org/project/mysql-connector-python/>`_ library.

Dependency
----------

* mysql-connector-python


Parameters
----------

Required:

* `user` is the database user.
* `password` is the database password.
* `host` is the host name, IP address, or URL.
* `port` is the port used to make TCP/IP connection.
* `database` is the database name.


Create Connection
-----------------

.. code-block:: text

CREATE DATABASE mysql_data WITH ENGINE = 'mysql', PARAMETERS = {
"user": "eva",
"password": "password",
"host": "localhost",
"port": "5432",
"database": "evadb"
};

2 changes: 1 addition & 1 deletion docs/source/reference/evaql/create.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The CREATE DATABASE statement allows us to connect to an external structured dat
PARAMETERS = [key_value_parameters];

* [database_connection] is the name of the database connection. `[database_connection].[table_name]` will be used as table name to compose SQL queries in EvaDB.
* [database_engine] is the supported database engine. Check :ref:`supported data sources<data-sources>` for all engine and their available configuration parameters.
* [database_engine] is the supported database engine. Check :ref:`supported data sources<databases>` for all engine and their available configuration parameters.
* [key_value_parameters] is a list of key-value pairs as arguments to establish a connection.


Expand Down