Interface PutOpt

Options passed to put.

Hierarchy

Properties

compartment? durability? exactMatch? identityCacheSize? ifAbsent? ifPresent? matchVersion? namespace? returnExisting? timeout? ttl? updateTTLToDefault?

Properties

Optional compartment

compartment?: string

Cloud service only. Compartment id or name to use for this operation.

Default Value

Config.compartment.

See

compartment

Optional durability

durability?: Durability

On-premises only. Set the desired durability for master/replica sync/acks. Defaults to durability or if not set, the default server-side durability settings are used. See Durability.

Optional exactMatch

exactMatch?: boolean

If true the value must be an exact match for the table schema or the operation will fail. An exact match means that there are no required fields missing and that there are no extra, unknown fields. The default behavior is to not require an exact match.

Optional identityCacheSize

identityCacheSize?: number

Sets the number of generated identity values that are requested from the server during a put. This takes precedence over the DDL identity CACHE option set during creation of the identity column. Must be positive integer.

Default Value

If not set, the DDL identity CACHE value is used.

Optional ifAbsent

ifAbsent?: boolean

If set to true, do put only if there is no existing row that matches the primary key. Exclusive with ifPresent and matchVersion.

Optional ifPresent

ifPresent?: boolean

If set to true, do put only if there is existing row that matches the primary key. Exclusive with ifAbsent and matchVersion.

Optional matchVersion

matchVersion?: RowVersion

If set, do a put only if there is an existing row that matches the primary key and its RowVersion matches the value provided. Exclusive with ifAbsent and ifPresent.

Optional namespace

namespace?: string

On-premises only. Namespace to use for this operation.

Note: if a namespace is specified in the table name for the request (using the namespace:table_name format), that value will override this setting.

Default Value

Config.namespace.

See

namespace

Optional returnExisting

returnExisting?: boolean

If set to true, existing row and its version will be returned as part of PutResult if put operation fails as discussed in put.

Optional timeout

timeout?: number

Timeout for the operation in milliseconds.

Default Value

Config.timeout

Optional ttl

ttl?: number | TimeToLive

Sets TimeToLive value, causing the time to live on the row to be set to the specified value on Put. This value overrides any default time to live setting on the table. If passed as number, interpreted as number of days.

See

TimeToLive.

Optional updateTTLToDefault

updateTTLToDefault?: boolean

If set to true, and there is an existing row, causes the operation to update the time to live (TTL) value of the row based on the table's default TTL if set. If the table has no default TTL this state has no effect. By default updating an existing row has no effect on its TTL. This option cannot be specified if ttl is specified.

Settings

Member Visibility

Theme

Generated using TypeDoc