Skip to content

Dore PostgreSQL Protocol

Protocol name: postgres

Manifest fields

Field in Manifest What it represents
Datastore Database
Model Table
Attribute Column


Datastore Properties

Manifest path: $.datastores[*].properties

Example

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

Fields

  • host (string) [required]

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

    PostgreSQL host.

  • port (string) [required]

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

    PostgreSQL port.

  • user (string) [required]

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

    PostgreSQL username for connecting to the database.

  • password (string) [required]

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

    PostgreSQL password for connecting to the database.

  • database (string) [required]

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

    Name of the PostgreSQL database to connect to.


Model Properties

Manifest path: $.models[*].properties

Example

Postgres Model properties example
1
2
3
4
{
  "tableName": "foobar",
  "schemaName":" baz"
}

Fields

  • tableName (string) [required]

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

    Name of the PostgreSQL table that the model corresponds to.

    While interacting with the PostgreSQL table corresponding to the model, Dore uses this tableName to refer to the model in the PostgreSQL database.

  • schemaName (string) [required]

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

    Name of the PostgreSQL schema that the model corresponds to.

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


Attribute Properties

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

Example

Postgres Attribute properties example
1
2
3
4
{
  "columnName": "foo",
  "columnType": "VARCHAR(30)"
}

Fields

  • columnName (string) [required]

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

    Name of the Postgres column that the attribute corresponds to.

    While creating tables in Postgres for Postgres bound models in the manifest, Dore infers the required column name from this field's value.

  • columnType (string) [required]

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

    Data type of the Postgres column that the attribute corresponds to.

    All data types supported by Postgres are supported here.