C# Class Arango.Client.AIndex

Mostrar archivo Open project: yojimbo87/ArangoDB-NET

Public Methods

Method Description
Create ( string collectionName ) : object>>.AResult

Creates index within specified collection in current database context.

Delete ( string id ) : object>>.AResult

Deletes specified index.

Fields ( ) : AIndex

Determines an array of attribute paths in the collection with hash, fulltext, geo or skiplist indexes.

GeoJson ( bool value ) : AIndex

Determines if the order within the array is longitude followed by latitude in geo index.

Get ( string id ) : object>>.AResult

Retrieves specified index.

MinLength ( int value ) : AIndex

Determines minimum character length of words for fulltext index. Will default to a server-defined value if unspecified. It is thus recommended to set this value explicitly when creating the index.

Sparse ( bool value ) : AIndex

Determines if the hash or skiplist index should be sparse.

Type ( AIndexType value ) : AIndex

Determines type of the index.

Unique ( bool value ) : AIndex

Determines if the hash or skiplist index should be unique.

Private Methods

Method Description
AIndex ( Connection connection ) : System

Method Details

Create() public method

Creates index within specified collection in current database context.
public Create ( string collectionName ) : object>>.AResult
collectionName string
return object>>.AResult

Delete() public method

Deletes specified index.
Specified id value has invalid format.
public Delete ( string id ) : object>>.AResult
id string
return object>>.AResult

Fields() public method

Determines an array of attribute paths in the collection with hash, fulltext, geo or skiplist indexes.
public Fields ( ) : AIndex
return AIndex

GeoJson() public method

Determines if the order within the array is longitude followed by latitude in geo index.
public GeoJson ( bool value ) : AIndex
value bool
return AIndex

Get() public method

Retrieves specified index.
Specified id value has invalid format.
public Get ( string id ) : object>>.AResult
id string
return object>>.AResult

MinLength() public method

Determines minimum character length of words for fulltext index. Will default to a server-defined value if unspecified. It is thus recommended to set this value explicitly when creating the index.
public MinLength ( int value ) : AIndex
value int
return AIndex

Sparse() public method

Determines if the hash or skiplist index should be sparse.
public Sparse ( bool value ) : AIndex
value bool
return AIndex

Type() public method

Determines type of the index.
public Type ( AIndexType value ) : AIndex
value AIndexType
return AIndex

Unique() public method

Determines if the hash or skiplist index should be unique.
public Unique ( bool value ) : AIndex
value bool
return AIndex