Struct CommentStatement 

pub struct CommentStatement { /* private fields */ }

Available on native and crate feature database only.

COMMENT ON statement builder

This struct provides a fluent API for constructing COMMENT ON queries.

Examples

use reinhardt_query::prelude::*;
use reinhardt_query::types::CommentTarget;

// COMMENT ON TABLE "users" IS 'User account information'
let query = Query::comment()
    .target(CommentTarget::Table("users".into_iden()))
    .comment("User account information");

// COMMENT ON COLUMN "users"."email" IS 'User email address'
let query = Query::comment()
    .target(CommentTarget::Column("users".into_iden(), "email".into_iden()))
    .comment("User email address");

// COMMENT ON TABLE "users" IS NULL (remove comment)
let query = Query::comment()
    .target(CommentTarget::Table("users".into_iden()))
    .comment_null();

Implementations

impl CommentStatement

pub fn new() -> CommentStatement

Create a new COMMENT ON statement

Examples

use reinhardt_query::prelude::*;

let query = Query::comment();

pub fn take(&mut self) -> CommentStatement

Take the ownership of data in the current CommentStatement

pub fn target(self, target: CommentTarget) -> CommentStatement

Set the target object for the comment

Examples

use reinhardt_query::prelude::*;
use reinhardt_query::types::CommentTarget;

let query = Query::comment()
    .target(CommentTarget::Table("users".into_iden()));

pub fn comment<S>(self, comment: S) -> CommentStatement

where S: Into<String>,

Set the comment text

Examples

use reinhardt_query::prelude::*;
use reinhardt_query::types::CommentTarget;

let query = Query::comment()
    .target(CommentTarget::Table("users".into_iden()))
    .comment("User account information");

pub fn comment_null(self) -> CommentStatement

Set the comment to NULL (remove comment)

Examples

use reinhardt_query::prelude::*;
use reinhardt_query::types::CommentTarget;

let query = Query::comment()
    .target(CommentTarget::Table("users".into_iden()))
    .comment_null();

Trait Implementations

impl Clone for CommentStatement

fn clone(&self) -> CommentStatement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommentStatement

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

Formats the value using the given formatter.

impl Default for CommentStatement

fn default() -> CommentStatement

Returns the “default value” for a type.

impl QueryStatementBuilder for CommentStatement

fn build_any( &self, query_builder: &(dyn QueryBuilderTrait + 'static), ) -> (String, Values)

Build SQL statement for a database backend and collect query parameters

fn to_string<T>(&self, query_builder: T) -> String

where T: QueryBuilderTrait,

Build SQL statement for a database backend and return SQL string with values inlined as SQL literals.

fn build<T>(&self, query_builder: T) -> (String, Values)

where T: QueryBuilderTrait,

Build SQL statement with parameter collection

impl QueryStatementWriter for CommentStatement