Skip to content

Commit

Permalink
Merge pull request #80 from ihuicatl/docs
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
JohanMabille committed Nov 24, 2023
2 parents 73e8a6f + 69bf030 commit f6e0195
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 8 deletions.
8 changes: 4 additions & 4 deletions docs/source/firebird.rst → docs/source/Firebird.rst
Expand Up @@ -15,7 +15,7 @@ Installation

Install Firebird using your preferred method. You will likely need the developer's version of Firebird for it to be picked up by SOCI.

If you're using a system's package manager your Firebird installation won't be picked up by the SOCI package available on ``conda-forge`` meaning you will either have to install SOCI from source or download it from SOCI page_.
If you're using a system's package manager, your Firebird installation won't be picked up by the SOCI package available on ``conda-forge``, meaning that you will either have to install SOCI from source or download it from SOCI `downloads page <https://sourceforge.net/projects/soci/>`_.

Make sure you're installing SOCI after you have Firebird in your system.

Expand All @@ -36,19 +36,19 @@ To install SOCI from source use the following flags when building:
make install
Just make sure to do that in the same environment as the rest of your installation is going.
Just make sure to do that in the same environment as the rest of your installation.

Usage
*****

Either way you decide to conduce your installation process you have to make sure that the directory where your database is is accessible by Jupyter Lab. To do that you can add the user of the machine to the ``firebird`` group:
Either way you decide to conduct your installation process you have to make sure that the directory where your database is is accessible by JupyterLab. To do that, you can add the user of the machine to the ``firebird`` group:

.. code::
sudo chown firebird:firebird $DATABASE_NAME
sudo usermod -a -G firebird $USER_NAME
That's all that there's to it. You can now run the example contained in ``examples/Firebird.ipynb``.
That's all there's to it. You can now run the example contained in ``examples/Firebird.ipynb``.

More information about Firebird can be found in the SOCI documentation_.

Expand Down
22 changes: 18 additions & 4 deletions docs/source/PostgreSQL.rst
Expand Up @@ -7,6 +7,13 @@
PostgreSQL
==========

**Requirements:** ``soci-postgresql``

.. code::
conda install soci-postgresql -c conda-forge
Linux
-----

Expand All @@ -16,7 +23,7 @@ If you're running ``xeus-sql`` with a conda-forge PostgreSQL build, you will hav
sudo ln -s /var/run/postgresql/.s.PGSQL.5432 /tmp/.s.PGSQL.5432
Create an user:
Create a user:

.. code::
Expand All @@ -28,14 +35,21 @@ Start the service:
sudo service postgresql start sudo -u $USER_NAME psql
Create a database using the example available on this repository:
Create a new database:

.. code::
createdb newdvdrental
Use the example available on this repository:

.. code::
pg_restore --dbname=newdvdrental -U $USER_NAME pathto/xeus-sql/examples/dvdrental.tar
pg_restore --dbname=newdvdrental -U $USER_NAME path/to/xeus-sql/examples/dvdrental.tar
You can now run the example contained in ``examples/PostgreSQL.ipynb``.

More information about PostgreSQL can be found in the SOCI documentation_.

.. _documentation: http://soci.sourceforge.net/doc/release/4.0/backends/postgresql/
.. _documentation: http://soci.sourceforge.net/doc/release/4.0/backends/postgresql/

0 comments on commit f6e0195

Please sign in to comment.