Enum IndexType 

pub enum IndexType {
    BTree,
    Hash,
    Gin,
    Gist,
    Brin,
    FullText,
}

Index access method / algorithm.

The default (when None is stored on IndexIr) lets the DBMS choose (BTree on every supported database).

Variants

BTree

B-Tree (default on all databases).

Hash

Hash index — PostgreSQL and MySQL 8+.

Gin

Generalized Inverted Index — PostgreSQL only (arrays, JSONB, full-text).

Gist

Generalized Search Tree — PostgreSQL only (geometry, range types).

Brin

Block Range Index — PostgreSQL only (large ordered tables).

FullText

Full-text index — MySQL only.

Implementations

impl IndexType

pub fn supported_by(self, provider: DatabaseProvider) -> bool

Returns true when this index type is supported by the given database provider.

pub fn supported_providers(self) -> &'static str

Human-readable list of supported providers (for diagnostics).

pub fn as_str(self) -> &'static str

The canonical display name used in schema files.

Trait Implementations

impl Clone for IndexType

fn clone(&self) -> IndexType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexType

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

Formats the value using the given formatter.

impl FromStr for IndexType

type Err = ParseIndexTypeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for IndexType

fn eq(&self, other: &IndexType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for IndexType

impl Eq for IndexType

impl StructuralPartialEq for IndexType