Aasaanjobs Elasticsearch SDK
Library to handle elasticsearch related transactions in Python (for internal usage in Aasaanjobs)
Requirements
- Python 3.5 and greater
- Elasticsearch Python
Installation
Install using pip
pip install ajelastic
Configuration
The AJ Elastic library reads configurations from module path specified in the environment
variable AJELASTIC_SETTINGS_MODULE if its a standalone python project, or the
DJANGO_SETTINGS_MODULE environment variable if its a Django project.
export AJELASTIC_SETTINGS_MODULE=tests.settings
Example
Below is an example settings module that can be consumed by the library
# Mandatory Settings
# Elasticsearch host and port
ES_HOST = "http://localhost:9200"
# The environment suffix that will be added in the Elasticsearch index names
ES_ENV = "development"
# Optional Settings
# List of Elasticsearch indices
ES_INDICES = {
"User": {
"name": "users", # The index name prefix
"doc_type": "user", # Elastic document type
"data_functions": {
"single": "tests.data:get_user", # Function to fetch a user; should accept a single ID argument
"multi": "tests.data:list_users" # Function to fetch list of users; should accept two arguments; limit and offset
},
"mapping_path": "tests/user_mapping.json" # Path to the JSON mapping of the document structure
}
}
Commands to Sync Data with Elasticsearch
This library provides the following command line scripts to synchronize/initialize data
aj-es-reindex
This command will reindex the documents from scratch fetching data from the function defined in the data_functions.multi
settings of the entity (i.e., withing the ES_INDICES settings).
For eg, the below command will reindex the User entity, fetching data from the list_users function (as specified in the settings)
with a batch size of 100, i.e., in a single request 100 users will be index to elasticsearch.
aj-es-reindex User 100
Metadata
Release files for ajelastic 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ajelastic-1.0.2.tar.gz | 7.4 kB | Without provenance | Details for ajelastic-1.0.2.tar.gz |
Release files / ajelastic-1.0.2.tar.gz
| Download URL | ajelastic-1.0.2.tar.gz |
|---|---|
| Size | 7.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
360bbe40419c4f2d417dfcf178b67d88f140610c5234882e7693b86366c5ed0e
|
|
BLAKE2b-256 checksum How to use checksums |
47c49549fcc6c2c7d13ef69d2f701c62161e36ba98dd34dfa4976ae0a178eb1d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for ajelastic 1.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.