Skip to main content

Fts5Table

Struct Fts5Table 

Source
pub struct Fts5Table { /* private fields */ }
Expand description

Assembles CREATE VIRTUAL TABLE … USING fts5(…) without hand-writing the module arguments.

use toolu_orm_core::column::ColumnType;
use toolu_orm_core::fts5::Fts5Table;

let table = Fts5Table::new("memory_fts")
  .unindexed_column("memory_id", ColumnType::Text)
  .column("body", ColumnType::Text)
  .tokenize("porter unicode61")
  .build();

assert_eq!(table.kind.module(), Some("fts5"));
assert_eq!(table.kind.args()[0], "\"memory_id\" UNINDEXED");

Implementations§

Source§

impl Fts5Table

Source

pub fn new(name: impl Into<String>) -> Self

Source

pub fn column(self, name: impl Into<String>, column_type: ColumnType) -> Self

A searchable column. FTS5 stores every column as text; column_type is kept as metadata for the generated typed columns and is never rendered into the DDL.

Source

pub fn unindexed_column( self, name: impl Into<String>, column_type: ColumnType, ) -> Self

A column stored but not indexed (UNINDEXED), so it is returned by queries but never matched by MATCH.

Source

pub fn tokenize(self, spec: impl Into<String>) -> Self

The tokenizer chain, e.g. porter unicode61 remove_diacritics 2.

Source

pub fn prefix(self, spec: impl Into<String>) -> Self

Prefix index sizes, e.g. 2 3.

Source

pub fn content(self, table: impl Into<String>) -> Self

External content table; the empty string makes the table contentless.

Source

pub fn content_rowid(self, column: impl Into<String>) -> Self

The rowid column of the external content table.

Source

pub fn columnsize(self, value: u8) -> Self

columnsize = 0 drops the per-column size index.

Source

pub fn detail(self, value: impl Into<String>) -> Self

Detail level: full, column, or none.

Source

pub fn build(self) -> TableDef

The finished definition, with the module arguments rendered into TableKind::Virtual.

Trait Implementations§

Source§

impl Clone for Fts5Table

Source§

fn clone(&self) -> Fts5Table

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Fts5Table

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Fts5Table

Source§

fn default() -> Fts5Table

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more