Struct Index 

pub struct Index {
    pub name: String,
    pub fields: Vec<String>,
    pub unique: bool,
    pub condition: Option<String>,
    pub include: Vec<String>,
    pub opclass: Option<String>,
}

Available on crate feature database and non-WebAssembly only.

Index definition

Fields

name: String

The name.

fields: Vec<String>

The fields.

unique: bool

The unique.

condition: Option<String>

The condition.

include: Vec<String>

The include.

opclass: Option<String>

The opclass.

Implementations

impl Index

pub fn new(name: impl Into<String>, fields: Vec<String>) -> Index

Create a new database index on specified fields

Examples

use reinhardt_db::orm::indexes::Index;

let index = Index::new("user_email_idx", vec!["email".to_string()]);
assert_eq!(index.name, "user_email_idx");
assert_eq!(index.fields.len(), 1);
assert!(!index.unique); // Not unique by default

pub fn unique(self) -> Index

Documentation for unique

pub fn with_condition(self, condition: String) -> Index

Documentation for with_condition

pub fn include(self, fields: Vec<String>) -> Index

Documentation for include

pub fn with_opclass(self, opclass: String) -> Index

Documentation for with_opclass

pub fn to_sql(&self, table: &str) -> String

Documentation for to_sql

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Index, <__D as Deserializer<'de>>::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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.