diff --git a/docs/data-processing/postgresql/index.rst b/docs/data-processing/postgresql/index.rst index e4eb2df9..c71e1a51 100644 --- a/docs/data-processing/postgresql/index.rst +++ b/docs/data-processing/postgresql/index.rst @@ -124,7 +124,7 @@ Cross platform orm sqlalchemy alembic - ipython-sql + jupysql postgis/index sec performance diff --git a/docs/data-processing/postgresql/ipython-sql.rst b/docs/data-processing/postgresql/jupysql.rst similarity index 89% rename from docs/data-processing/postgresql/ipython-sql.rst rename to docs/data-processing/postgresql/jupysql.rst index 04e72c2b..c960383f 100644 --- a/docs/data-processing/postgresql/ipython-sql.rst +++ b/docs/data-processing/postgresql/jupysql.rst @@ -1,22 +1,22 @@ -ipython-sql +Jupysql =========== -`ipython-sql `_ introduces the +`Jupysql `_ introduces the ``%sql`` or ``%%sql`` magics for iPython and Jupyter notebooks. Installation ------------ -You can easily install ipython-sql in your Jupyter kernel with: +You can easily install jupysql in your Jupyter kernel with: .. code-block:: console - $ pipenv install ipython-sql + $ pipenv install jupysql First steps ----------- -#. First, ipython-sql is activated in your notebook with +#. First, Jupysql is activated in your notebook with .. code-block:: python @@ -103,7 +103,7 @@ If pandas is installed, the ``DataFrame`` method can be used: PostgreSQL features ------------------- -Meta-commands from ``psql`` can also be used in ipython-sql: +Meta-commands from ``psql`` can also be used in jupysql: ``-l``, ``--connections`` lists all active connections @@ -126,7 +126,7 @@ Meta-commands from ``psql`` can also be used in ipython-sql: * `pgspecial `_ .. warning:: - Since ipython-sql processes ``--`` options such as ``-persist``, and at the + Since jupysql processes ``--`` options such as ``-persist``, and at the same time accepts ``--`` as a SQL comment, the parser has to make some assumptions: for example, ``--persist is great`` in the first line is processed as an argument and not as a comment.