\CouchbaseN1qlIndex

Represents N1QL index definition

Summary

Methods
Properties
Constants
No public methods found
$name
$isPrimary
$type
$state
$keyspace
$namespace
$fields
$condition
UNSPECIFIED
GSI
VIEW
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

UNSPECIFIED

UNSPECIFIED

GSI

GSI

VIEW

VIEW

Properties

$name

$name : string

Name of the index

Type

string

$isPrimary

$isPrimary : boolean

Is it primary index

Type

boolean

$type

$type : integer

Type of the index

Type

integer

$state

$state : string

The descriptive state of the index

Type

string

$keyspace

$keyspace : string

The keyspace for the index, typically the bucket name

Type

string

$namespace

$namespace : string

The namespace for the index. A namespace is a resource pool that contains multiple keyspaces

Type

string

$fields

$fields : array

The fields covered by index

Type

array

$condition

$condition : string

Return the string representation of the index's condition (the WHERE clause of the index), or an empty String if no condition was set.

Note that the query service can present the condition in a slightly different manner from when you declared the index: for instance it will wrap expressions with parentheses and show the fields in an escaped format (surrounded by backticks).

Type

string