Show / Hide Table of Contents

Class CreateIndexDetails

Specifications for the new index.

Inheritance
object
CreateIndexDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.NosqlService.Models
Assembly: OCI.DotNetSDK.Nosql.dll
Syntax
public class CreateIndexDetails

Properties

CompartmentId

Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the table's compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and compartmentId is supplied, the latter must match the identified table's compartmentId.

IsIfNotExists

Declaration
[JsonProperty(PropertyName = "isIfNotExists")]
public bool? IsIfNotExists { get; set; }
Property Value
Type Description
bool?

If true, the operation completes successfully even when the index exists. Otherwise, an attempt to create an index that already exists will return an error.

Keys

Declaration
[Required(ErrorMessage = "Keys is required.")]
[JsonProperty(PropertyName = "keys")]
public List<IndexKey> Keys { get; set; }
Property Value
Type Description
List<IndexKey>

A set of keys for a secondary index.

Remarks

Required

Name

Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

Index name.

Remarks

Required

In this article
Back to top