Struct PrimaryKeyDef 

pub struct PrimaryKeyDef {
    pub table: &'static str,
    pub name: &'static str,
    pub columns: &'static [Cow<'static, str>],
    pub name_explicit: bool,
}

A table’s primary key, buildable in a const.

TableSql writes a single-column key without an explicit name inline on the column, and any other key as a table constraint.

Examples

use drizzle_types::sqlite::ddl::PrimaryKeyDef;
use std::borrow::Cow;

const COLS: &[Cow<'static, str>] = &[Cow::Borrowed("user_id"), Cow::Borrowed("role_id")];
const PK: PrimaryKeyDef = PrimaryKeyDef::new("user_roles", "pk_user_roles")
    .columns(COLS);

Fields

table: &'static str

Parent table name

name: &'static str

Constraint name

columns: &'static [Cow<'static, str>]

Columns in the primary key

name_explicit: bool

Whether the user gave the constraint name (rather than it being generated)

Implementations

impl PrimaryKeyDef

pub const fn new(table: &'static str, name: &'static str) -> Self

Creates a primary key with no columns; set them with columns.

pub const fn columns(self, cols: &'static [Cow<'static, str>]) -> Self

Sets the key’s columns.

pub const fn explicit_name(self) -> Self

Marks the name as given by the user.

pub const fn into_primary_key(self) -> PrimaryKey

Converts to the runtime PrimaryKey.

Trait Implementations

impl Clone for PrimaryKeyDef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PrimaryKeyDef

impl Debug for PrimaryKeyDef

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

Formats the value using the given formatter.

impl Default for PrimaryKeyDef

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PrimaryKeyDef

impl From<PrimaryKeyDef> for PrimaryKey

fn from(def: PrimaryKeyDef) -> Self

Converts to this type from the input type.

impl Hash for PrimaryKeyDef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PrimaryKeyDef

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PrimaryKeyDef