Cmdlets for Couchbase

Build 21.0.7930

ExposeTTL Parameter (Connect-Couchbase Cmdlet)

Specifies whether document TTL information should be exposed.

Syntax

Connect-Couchbase -ExposeTTL SwitchParameter

Data Type

bool

Default Value

false

Remarks

By default the {i does not expose TTL values or consider document TTLs when performing DML operations. Enabling this option exposes TTL values in two ways:

  • All tables get a new column called Document.Expiration which contains the TTL value for each document. This column is an integer and returns whatever TTL value is stored in Couchbase directly. This column is read-write on bucket tables and read-only on child tables.
  • INSERT and UPDATE will use this field to set TTL values, or to preserve them (for update) when none is provided. Setting the field to either 0 or NULL will remove the TTL from any affected documents.

Note that enabling this features requires that your server be version 6.5.1 or later and that your CouchbaseService is set to N1QL. If either of these is not the case the {i will not connect.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930