sedentary.rst

Sedentary

The base ORM class.

TODO

new Sedentary([options])

• options?: :ref:`SedentaryOptions` - default {} - The global options.
• returns the :ref:`Sedentary` object to interact with the database.

Warning

Do not use this constructor directly.

new SedentaryPG(config[, options])

• config: :xref:`pg.PoolConfig` - required - The connection configuration object.
• options?: :ref:`SedentaryOptions` - default {} - The global options
• returns the :ref:`SedentaryPG<Sedentary>` object to interact with the database.

:ref:`SedentaryPG<Sedentary>` uses :xref:`pg.Pool` to connect to the database; please refer to :xref:`pg` and its :xref:`pg-documentation` for details about the config object.

sedentary.connect([sync])

• sync: :xref:`boolean` - default false - Specifies whether to execute the sync process or not.
• returns a :xref:`Promise` which resolves with :xref:`void`.

Connects to the database and eventually syncs the schema. The value of the sync argument is ignored unless the :ref:`autoSync<SedentaryOptions.autoSync>` option was set to false when :ref:`new Sedentary<new Sedentary>` was called.

Note

Must be called only once.

sedentary.end()

• returns a :xref:`Promise` which resolves with :xref:`void`.

Closes the connection with the database.

Note

Must be called only once, after :ref:`sedentary.connect()<sedentary.connect>`.

sedentary.model(name, fields[, options [, methods]])

• name: :xref:`string` - required - The name of the model.
• fields: :ref:`AttributesDefinition` - required - The object with the fileds definitions.
• options?: :ref:`ModelOptions` - default {} - The options of the model.
• methods?: :ref:`Methods` - default {} - The JavaScript level methods of the model.
• returns a new :ref:`class Model<Model>` to interact with the TABLE.

Defines one model. Should be called once for each model/TABLE to be configured.

Note

Must be called before :ref:`sedentary.connect()<sedentary.connect>`.

sedentary.DATETIME()

• returns a DATETIME :ref:`Type`.

It is the :ref:`Type function` to specify DATETIME as type for a field.

sedentary.FKEY(attribute, options)

• attribute: - :ref:`Model` | :ref:`ModelAttribute` - required - The foreign key target attribute.
• options: - :ref:`ForeignKeyOptions` - default {} - The foreign key options.
• returns the :ref:`Type` of the target attribute.

It is the :ref:`Type function` to specify a :ref:`foreign key<Foreign keys>`. It can be either :ref:`Model` or a :ref:`ModelAttribute`. If a :ref:`Model` is provided, its :ref:`primary key` is the target attribute.

sedentary.INT(size)

• size: :xref:`number` - default: 4 - The size of the field at database level.
• returns an INT :ref:`Type`.

It is the :ref:`Type function` to specify INT as type for a field. If the value of the size argument is 2, a 16 bit INT :ref:`Type` is returned; if 4, a 32 bit INT :ref:`Type` is returned; no other values are accepted.

sedentary.INT8

• returns an INT :ref:`Type`.

It is the :ref:`Type function` to specify 64 bit INT as type for a field. It is a distinct :ref:`Type function` from :ref:`sedentary.INT<sedentary.INT>` to give the attribute a specific type at TypeScript level. TODO

sedentary.VARCHAR(size)

• size: :xref:`number` - default undefined- The size of the field at database level.
• returns an VARCHAR :ref:`Type`.

It is the :ref:`Type function` to specify VARCHAR as type for a field. If a value of the size argument is provided, it is the maximum allowed string size at database level.