Struct arangors::index::Index

pub struct Index {
    pub fields: Vec<String>,
    pub name: String,
    pub id: String,
    pub is_newly_created: Option<bool>,
    pub selectivity_estimate: Option<u8>,
    pub in_background: Option<bool>,
    pub settings: IndexSettings,
}

Represents an Index in ArangoDB. The following types are supported:

• Fulltext
• Geo
• Hash
• Persistent
• Skiplist
• Ttl (Time to live)

As different settings may be applied to different index types, use the [settings] field on the index to specify the exact type of the index including the required settings.

Example

let database = conn.db("test_db").await.unwrap();

let index = Index::builder()
    .name("doc_test_index_name")
    .fields(vec!["password".to_string()])
    .settings(IndexSettings::Persistent {
        unique: true,
        sparse: false,
        deduplicate: false,
    })
    .build();

let index = database.create_index("test_collection", &index).await?;
let delete_result = database.delete_index(&index.id).await.unwrap();

Fields

fields: Vec<String>

name: String

id: String

is_newly_created: Option<bool>

selectivity_estimate: Option<u8>

in_background: Option<bool>

settings: IndexSettings

Implementations

impl Index

pub fn builder() -> IndexBuilder<((), (), (), (), (), (), ())>

Create a builder for building Index. On the builder, call .fields(...)(optional), .name(...)(optional), .id(...)(optional), .is_newly_created(...)(optional), .selectivity_estimate(...)(optional), .in_background(...)(optional), .settings(...)(optional) to set the values of the fields (they accept Into values). Finally, call .build() to create the instance of Index.

Trait Implementations

impl Debug for Index

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Index

fn default() -> Index

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Index

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Index

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.