Metadata-Version: 2.1
Name: sqlalchemy-solr
Version: 0.2.2
Summary: Apache Solr Dialect for SQLAlchemy and Apache Superset
Home-page: https://github.com/aadel/sqlalchemy-solr
Author: Ahmed Adel
Author-email: hello@aadel.io
License: MIT
Description: # Apache Solr dialect for SQLAlchemy and Apache Superset
        
        A dialect for Apache Solr that can be used with [Apache Superset](https://superset.apache.org).
        
        ## Installation
        
        The package can either be installed through PyPi or from the source code.
        
        #### Through Python Package Index
        
        `pip install sqlalchemy-solr`
        
        #### Latest from Source Code
        
        `pip install git+https://github.com/aadel/sqlalchemy-solr`
        
        ## 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]
        ```
        
        ## Basic Example
        
        The following example illustrates the basic usage in a Python project:
        
        ```
        engine = create_engine('solr://solr:8983/solr/examples_books')
        
        with engine.connect() as connection:
            result = connection.execute(text("SELECT sequence_i, genre_s FROM examples_books"))
            for row in result:
                print("Sequence: {}, Genre: {}".format(row['sequence_i'], row['genre_s']))
        ```
        
        ## Testing
        
        #### Requirements
        
        * A Solr instance with a Parallel SQL supported up and running
        * A Superset instance up and running with this package installed
        * `pytest` >= 6.2.1 installed on the testing machine
        
        #### Procedure
        
        1. Change `conftest.py` as appropriate
        2. Run `pytest`
        
        ## Resources
        1. [SQLAlchemy documentation](https://docs.sqlalchemy.org/en/13/index.html)
        2. [SQLAlchemy dialects](https://docs.sqlalchemy.org/en/13/dialects/index.html)
        
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
