Metadata-Version: 1.1
Name: wukong
Version: 0.2.2
Summary: An ORM Client library for SolrCloud
Home-page: https://github.com/SurveyMonkey/wukong
Author: Da Kuang
Author-email: dkuang1980@gmail.com
License: UNKNOWN
Description: # Wukong
        
        [![Latest Version](https://badge.fury.io/py/wukong.svg)](https://pypi.python.org/pypi/wukong/)
        [![Travis CI Build Status](https://travis-ci.org/SurveyMonkey/wukong.svg?branch=master)](https://travis-ci.org/SurveyMonkey/wukong)
        [![Coveralls Coverage Status](https://coveralls.io/repos/github/SurveyMonkey/wukong/badge.svg?branch=master)](https://coveralls.io/github/SurveyMonkey/wukong?branch=master)
        
        
        Wukong offers an ORM query engine for Solr and Solr Cloud.
        
        ##Installation
        ```
        	pip install wukong
        ```
        
        ##Usage
        
        
        ###Create Solr Collection
        Before you use wukong, make sure you already created your collection on SolrCloud. For example,
        ```
        	curl http://localhost:8080/solr/admin/collections?action=CREATE&name=users&numShards=1&replicationFactor=2
        ```
        
        A sample schema can be like:
        ```
        <fields>
        	<uniqueKey>id</uniqueKey>
          	<field name="id" type="int" indexed="true" stored="true" required="true" />
        	<field name="name" type="string" indexed="true" stored="true" required="true"/>
        	<field name="city" type="string" indexed="true" stored="true"/>
        	<field name="age" type="int" indexed="true" stored="true"/>
        	...
        </fields>
        ```
        
        ###Create a model class for Solr collection
        Create a class for your Solr collection by extending the class `SolrDoc`. For example,
        
        ```
        from wukong.models import SolrDoc
        
        class User(SolrDoc):
            collection_name = "users"
            solr_hosts = "localhost:8080,localhost:8081"
        
            def validate_schema_fields(self, fields):
            	pass
        
            def get_data_for_solr(self):
            	pass
        
        ```
        You can overide existing methods to fit your business logic, like `validate_schema_fields`, `get_data_for_solr`.
        
        
        ###Use Solr QueryManger
        
        Creat a document
        ```
        User.documents.create(User_id=12345, name="Test Name", city="Test City")
        ```
        
        Update a document
        ```
        User.documents.update(User_id=12345, name="Test Name")
        ```
        
        To index a batch of documentsto your Solr collection, use the container class: SolrDocs. Instead of accessing SOLR
        multiple times, it only issues one request to SOLR, which is more efficient.
        
        ```
        	docs = [
        		User(User_id=12345, name="Test Name1", city="Test Cit1"),
        		User(User_id=123456, name="Test Name2", city="Test City2")
        		...
        	]
        	docs = SolrDocs(docs)
        	docs.index()
        ```
        
        Fetch a document
        ```
        User.documents.get(User_id__eq=12345)
        ```
        
        Fetch multiple documents
        ```
        User.documents.filter(name__eq="Test Name", city__wc="Test*").all()
        ```
        
        Use compounded logic
        ```
        User.documents.filter(OR(city__wc="Test*", name__eq="Test Name"))
        ```
        
        Sort by a field
        ```
        User.documents.sort_by("-name").all()
        ```
        
        Force only return a certain fields
        ```
        User.documents.only("is", "name").all()
        ```
        
        Force only return the top 10 documents
        ```
        User.documents.limit(10).all()
        ```
        
        Chain the query methods
        ```
        User.documents.filter(city__wc="Test*").sort_by("-name").limit(10).all()
        ```
        
        Delete a document
        ```
        User.documents.get(User_id__eq=12345).delete()
        ```
        
        Batch delete documents
        ```
        User.documents.filter(name__eq="Test Name").all().delete()
        ```
        
        ##Documentations
        
        Detailed docs can be found at http://wukong.readthedocs.io/en/latest/
        
        
        
        #Release Notes
        
        0.2.2
        ==========
        - Fix zookeeper cluster state unicode issue
        
        0.2.0
        ==========
        - Zookeeper states for Solr 6
        - handle situations with unknown Solr hostnames
        - support stats in the query for Solr 6
        
        0.1.1
        ==========
        - Add support for Python 3.x
        
        0.0.3
        ==========
        - initial version for wukong
        
Keywords: solr cloud solrcloud client python orm
Platform: UNKNOWN
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
