Skip to main content

{{ DESCRIPTION }}

Project description

ElasticSearch Extensions for datapackage-pipelines
==================================================

Install
-------

::

# use pip install

pip install datapackage-pipelines-elasticsearch

# OR clone the repo and install it with pip

git clone https://github.com/frictionlessdata/datapackage-pipelines-elasticsearch.git
pip install -e .

Usage
-----

You can use datapackage-pipelines-elasticsearch as a plugin for
(dpp)[https://github.com/frictionlessdata/datapackage-pipelines#datapackage-pipelines\ ].
In pipeline-spec.yaml it will look like this

.. code:: yaml

...
- run: elasticseach.dump.to_index

***``dump.to_index``***
~~~~~~~~~~~~~~~~~~~~~~~

Saves the datapackage to an ElasticSearch instance.

*Parameters*:

- ``engine`` - Connection string for connecting to the ElasticSearch
instance (URL syntax)
Also supports ``env://<environment-variable>``, which indicates that
the connection string should be fetched from the indicated
environment variable.
If not specified, assumes a default of ``env://DPP_ELASTICSEARCH``
Environment variable should take the form of 'host:port' or a
fully-qualified url (e.g.
'`https://user:pass@host:port <https://user:pass@host:port>`__\ ' or
'`https://host:port <https://host:port>`__\ ' etc.)
- ``indexes`` - Mapping between resources and indexes. Keys are index
names, value is a list of objects with the following attributes:
- ``resource-name`` - name of the resource that should be dumped to the
table
- ``doc-type`` - The document type to use when indexing docuemtns

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
datapackage_pipelines_elasticsearch-0.0.13-py2.py3-none-any.whl (5.4 kB) Copy SHA256 hash SHA256 Wheel py2.py3
datapackage-pipelines-elasticsearch-0.0.13.tar.gz (6.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page