Struct sea_query::func::PgFunc

pub struct PgFunc;

Function call helper.

Implementations

impl PgFunc

pub fn to_tsquery<T>(expr: T, regconfig: Option<u32>) -> SimpleExpr where
    T: Into<SimpleExpr>, 

This is supported on crate feature backend-postgres only.

Call TO_TSQUERY function. Postgres only.

The parameter regconfig represents the OID of the text search configuration. If the value is None the argument is omitted from the query, and hence the database default used.

Examples

use sea_query::{*, tests_cfg::*};

let query = Query::select()
    .expr(PgFunc::to_tsquery(Expr::val("a & b"), None))
    .to_owned();

assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"SELECT TO_TSQUERY('a & b')"#
);

pub fn to_tsvector<T>(expr: T, regconfig: Option<u32>) -> SimpleExpr where
    T: Into<SimpleExpr>, 

This is supported on crate feature backend-postgres only.

Call TO_TSVECTOR function. Postgres only.

The parameter regconfig represents the OID of the text search configuration. If the value is None the argument is omitted from the query, and hence the database default used.

Examples

use sea_query::{*, tests_cfg::*};

let query = Query::select()
    .expr(PgFunc::to_tsvector(Expr::val("a b"), None))
    .to_owned();

assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"SELECT TO_TSVECTOR('a b')"#
);

pub fn phraseto_tsquery<T>(expr: T, regconfig: Option<u32>) -> SimpleExpr where
    T: Into<SimpleExpr>, 

This is supported on crate feature backend-postgres only.

Call PHRASE_TO_TSQUERY function. Postgres only.

The parameter regconfig represents the OID of the text search configuration. If the value is None the argument is omitted from the query, and hence the database default used.

Examples

use sea_query::{*, tests_cfg::*};

let query = Query::select()
    .expr(PgFunc::phraseto_tsquery(Expr::val("a b"), None))
    .to_owned();

assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"SELECT PHRASETO_TSQUERY('a b')"#
);

pub fn plainto_tsquery<T>(expr: T, regconfig: Option<u32>) -> SimpleExpr where
    T: Into<SimpleExpr>, 

This is supported on crate feature backend-postgres only.

Call PLAIN_TO_TSQUERY function. Postgres only.

The parameter regconfig represents the OID of the text search configuration. If the value is None the argument is omitted from the query, and hence the database default used.

Examples

use sea_query::{*, tests_cfg::*};

let query = Query::select()
    .expr(PgFunc::plainto_tsquery(Expr::val("a b"), None))
    .to_owned();

assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"SELECT PLAINTO_TSQUERY('a b')"#
);

pub fn websearch_to_tsquery<T>(expr: T, regconfig: Option<u32>) -> SimpleExpr where
    T: Into<SimpleExpr>, 

This is supported on crate feature backend-postgres only.

Call WEBSEARCH_TO_TSQUERY function. Postgres only.

The parameter regconfig represents the OID of the text search configuration. If the value is None the argument is omitted from the query, and hence the database default used.

Examples

use sea_query::{*, tests_cfg::*};

let query = Query::select()
    .expr(PgFunc::websearch_to_tsquery(Expr::val("a b"), None))
    .to_owned();

assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"SELECT WEBSEARCH_TO_TSQUERY('a b')"#
);

pub fn ts_rank<T>(vector: T, query: T) -> SimpleExpr where
    T: Into<SimpleExpr>, 

This is supported on crate feature backend-postgres only.

Call TS_RANK function. Postgres only.

Examples

use sea_query::{*, tests_cfg::*};

let query = Query::select()
    .expr(PgFunc::ts_rank(Expr::val("a b"), Expr::val("a&b")))
    .to_owned();

assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"SELECT TS_RANK('a b', 'a&b')"#
);

pub fn ts_rank_cd<T>(vector: T, query: T) -> SimpleExpr where
    T: Into<SimpleExpr>, 

This is supported on crate feature backend-postgres only.

Call TS_RANK_CD function. Postgres only.

Examples

use sea_query::{*, tests_cfg::*};

let query = Query::select()
    .expr(PgFunc::ts_rank_cd(Expr::val("a b"), Expr::val("a&b")))
    .to_owned();

assert_eq!(
    query.to_string(PostgresQueryBuilder),
    r#"SELECT TS_RANK_CD('a b', 'a&b')"#
);

Trait Implementations

impl Clone for PgFunc

This is supported on crate feature backend-postgres only.

fn clone(&self) -> PgFunc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PgFunc

This is supported on crate feature backend-postgres only.

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

Formats the value using the given formatter.