Skip to content

Dore Elasticsearch Protocol

Protocol name: elasticsearch7, elasticsearch8

Manifest fields

Field in Manifest What it represents
Datastore Cluster
Model Index
Attribute Field


Datastore Properties

Manifest path: $.datastores[*].properties

Example

Elasticsearch Datastore properties example
1
2
3
4
5
6
{
  "host": "127.0.0.1",
  "port": "9001",
  "user": "john_doe",
  "password": "yourpassword"
}

Fields

  • host (string) [required]

    Manifest path: $.datastores[*].properties.host

    Elasticsearch host.

  • port (string) [required]

    Manifest path: $.datastores[*].properties.port

    Elasticsearch port.

  • user (string) [required]

    Manifest path: $.datastores[*].properties.user

    Elasticsearch username for connecting to the database.

  • password (string) [required]

    Manifest path: $.datastores[*].properties.password

    Elasticsearch password for connecting to the database.


Model Properties

Manifest path: $.models[*].properties

Example

Elasticsearch Model properties example
1
2
3
{
  "indexName": "foobar"
}

Fields

  • indexName (string) [required]

    Manifest path: $.models[*].properties.indexName

    Name of the Elasticsearch index that the model corresponds to.

    While interacting with the Elasticsearch indexes corresponding to the model, Dore uses this schemaName to refer to the schema in the Elasticsearch database.


Attribute Properties

Manifest path: $.models[*].attributes[*].properties

Example

Elasticsearch Attribute properties example
1
2
3
4
{
  "fieldName": "foo",
  "fieldType": "keyword"
}

Fields

  • fieldName (string) [required]

    Manifest path: $.models[*].attributes[*].properties.fieldName

    Name of the Elasticsearch field that the attribute corresponds to.

  • fieldType (string) [required]

    Manifest path: $.models[*].attributes[*].properties.fieldType

    Name of the Elasticsearch field that the attribute corresponds to.

    All field data types supported by Elasticsearch are supported here.