Skip to content

Dore MongoDB Protocol

Protocol name: mongodb

Manifest fields

Field in Manifest What it represents
Datastore Database
Model Collection
Attribute Field


Datastore Properties

Manifest path: $.datastores[*].properties

Example

MongoDB Datastore properties example
1
2
3
4
5
6
7
{
  "host": "127.0.0.1",
  "port": "27101",
  "user": "john_doe",
  "password": "yourpassword",
  "database": "foobar"
}

Fields

  • host (string) [required]

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

    MongoDB host.

  • port (string) [required]

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

    MongoDB port.

  • user (string) [required]

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

    MongoDB username for connecting to the database.

  • password (string) [required]

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

    MongoDB password for connecting to the database.

  • database (string) [required]

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

    Name of the MongoDB database to connect to.


Model Properties

Manifest path: $.models[*].properties

Example

MongoDB Model properties example
1
2
3
{
  "collectionName": "foobar"
}

Fields

  • collectionName (string) [required]

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

    Name of the MongoDB collection that the model corresponds to.

    While interacting with the MongoDB collection corresponding to the model, Dore uses this collectionName to refer to the model in the MongoDB database.


Attribute Properties

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

Example

MongoDB Attribute properties example
1
2
3
{
  "fieldName": "foo"
}

Fields

  • fieldName (string) [required]

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

    Name of the MongoDB field that the attribute corresponds to.