Skip to content

jacoblukose/suche

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Suche

An Elasticsearch Export Framework

Documentation

Installation

pip install suche

You need to have elasticsearch installed and running. More info: https://www.elastic.co/

Basic Usage

from suche import Suche
suche = Suche(elastic_address, elastic_port, index)

elastic_address: address for elasticsearch (optional)

elastic_port: port number for elasticsearch (optional)

index: index name of elasticsearch

Specific Functions

Change Index

suche.set_index(index)

index: index name of elasticsearch

Configuration Options

ELASTIC_ADDRESS: Address to elasticsearch

ELASTIC_PORT: elasticsearch port

Either, create a configuration file with name suche_config.json in the pwd, like below

{
  "ELASTIC_ADDRESS": "localhost",
  "ELASTIC_PORT": 9200,
  "SUCHE_OUTPUT": ""
}

or

create Suche objects with custom configuration options required as shown below

suche = Suche(elastic_address="localhost", elastic_port=9300, 
    index="default")

Input Format For query

####The query input should be on below json Format for FilterData.

    {
        "key": "name",
        "query": "atm"
     }

####The query input should be on below json Format for MultiFilter Data.

    [
        {
            "key": "name",
            "query": "atm"
        },
        {
            "key": "name",
            "query": "atm"
        }
     ]

Advanced Features

AllData

suche.allData(doc_type = "person", fields= ["email", "name"], output_format= 'csv')

Matches all data in the doc type doc_type and filter data in accordance to fields and return output_format

FilterData

Filtering takes a single json string to process

suche.filterData(doc_type="person", match_json = { "key": "is_custom_domain", "query": "false" }, 
                fields = ["email", "name", "current_location"], output_format= 'pkl')
  • Follow input format

Matches data in the doc type doc_type, match_json and filter data in accordance to fields and return output_format

MultiFilter Data

multifiltering takes a dict with multiple json to process output

suche.multiMatch(doc_type="person", multiple_match = [{ "key": "data", "query": "false" }, { "key": "country", "query": "India" }],
                fields = ["email", "name", "current_location"], output_format= 'pkl')
  • Follow input format

Matches data in the doc type doc_type, multiple_match and filter data in accordance to fields and return output_format

About

Elasticsearch Export Framework

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%