Skip to content

Commit 40c59ff

Browse files
authored
Merge pull request #40 from zbrookle/update_documentation
Update documentation
2 parents 8421cee + 69412b6 commit 40c59ff

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.rst

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ dataframe_sql
1919
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
2020
:target: https://github.com/psf/black
2121

22+
``dataframe_sql`` is a Python_ package that translates SQL syntax into operations on
23+
pandas_ DataFrames, a functionality which is not available in the central pandas
24+
package.
25+
26+
.. _Python: https://www.python.org/
27+
2228
Installation
2329
------------
2430

@@ -45,12 +51,13 @@ function you can produce a new DataFrame from the sql query.
4551
query("""select * from my_table""")
4652
4753
48-
The package currently only supports pandas_ but there are plans to support dask_ and
49-
rapids_ in the future.
54+
The package currently only supports pandas_ but there are plans to support dask_,
55+
rapids_, and modin_ in the future.
5056

5157
.. _pandas: https://github.com/pandas-dev/pandas
5258
.. _dask: https://github.com/dask/dask
5359
.. _rapids: https://github.com/rapidsai/cudf
60+
.. _modin: https://github.com/modin-project/modin
5461

5562
SQL Syntax
5663
----------
@@ -60,3 +67,15 @@ The SQL syntax for ``dataframe_sql`` is exactly the same as the syntax in
6067
You can find the full SQL syntax
6168
`here <https://github.com/zbrookle/sql_to_ibis#sql-syntax>`__
6269

70+
Why use dataframe_sql?
71+
----------------------
72+
73+
While there are other packages that accomplish the goal of using SQL with pandas
74+
DataFrames, all other packages such as pandasql_ actually use a database on the
75+
backend which defeats the purpose of using pandas_ to begin with. In the case of
76+
pandasql_ which uses SQLite, this can result in major performance bottlenecks.
77+
``dataframe_sql`` actually performs native pandas operations in memory on DataFrames,
78+
which avoids conflicts that may arise from using external databases.
79+
80+
.. _pandasql: https://github.com/yhat/pandasql
81+

0 commit comments

Comments
 (0)