Class ArrayIndexConfiguration
Configuration for indexing property values within nested arrays in documents, intended for use with the UNNEST query keyword.
Inherited Members
Namespace: Couchbase.Lite.Query
Assembly: Couchbase.Lite.dll
Syntax
public sealed class ArrayIndexConfiguration : IndexConfiguration
Constructors
| Improve this Doc View SourceArrayIndexConfiguration(String, IEnumerable<String>)
Constructor
Declaration
public ArrayIndexConfiguration(string path, IEnumerable<string> expressions = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | Path to the array, which can be nested to be indexed. Use "[]" to represent a property that is an array of each nested array level.For a single array or the last level array, the "[]" is optional. For instance, use "contacts[].phones" to specify an array of phones within each contact. |
System.Collections.Generic.IEnumerable<System.String> | expressions | An optional collection of strings, where each string represents an expression defining the values within the array to be indexed.If the array specified by the path contains scalar values. |
ArrayIndexConfiguration(String, String[])
Constructor
Declaration
public ArrayIndexConfiguration(string path, params string[] expressions)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | Path to the array, which can be nested to be indexed. Use "[]" to represent a property that is an array of each nested array level.For a single array or the last level array, the "[]" is optional. For instance, use "contacts[].phones" to specify an array of phones within each contact. |
System.String[] | expressions | An optional collection of strings, where each string represents an expression defining the values within the array to be indexed.If the array specified by the path contains scalar values. |
Properties
| Improve this Doc View SourcePath
Path to the array, which can be nested.
Declaration
public string Path { get; }
Property Value
Type | Description |
---|---|
System.String |