Metadata-Version: 2.1
Name: sqlalchemy-solr
Version: 0.1.dev0
Summary: Apache Solr Dialect for Apache Superset::SQLAlchemy
Home-page: https://github.com/aadel/sqlalchemy-solr
Author: Ahmed Adel
Author-email: hello@aadel.io
License: MIT
Keywords: Apache Solr Superset SQLAlchemy dialect
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Database :: Front-Ends
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: sqlalchemy

# Apache Solr dialect for SQLAlchemy

A dialect for Apache Solr that can be used with [Apache Superset](https://superset.incubator.apache.org).

## Installation
Installing the dialect is straightforward.  Simply:
1.  Clone or download this repository
2.  Navigate to the directory where you cloned the repository
3.  Run the python `setup.py` to install
4.  Restart Superset

```
git clone https://github.com/aadel/sqlalchemy-solr
cd sqlalchemy-solr
python3 setup.py install 

```

## Usage
To connect to Solr with SQLAlchemy, the following URL pattern can be used:

```
solr://<username>:<password>@<host>:<port>/solr/<collection>[?use_ssl=true|false]
```

## References
1. [SQLAlchemy documentation](https://docs.sqlalchemy.org/en/13/index.html)
2. [SQLAlchemy dialects](https://docs.sqlalchemy.org/en/13/dialects/index.html)


