Skip to main content

CreateUserStatement

Struct CreateUserStatement 

Source
pub struct CreateUserStatement {
    pub user_name: String,
    pub if_not_exists: bool,
    pub attributes: Vec<RoleAttribute>,
    pub default_roles: Vec<String>,
    pub options: Vec<UserOption>,
}
Expand description

CREATE USER statement builder

This struct provides a fluent API for building CREATE USER statements.

§PostgreSQL

PostgreSQL CREATE USER is an alias for CREATE ROLE WITH LOGIN. Use the `attribute()` method to add role attributes.

§MySQL

MySQL CREATE USER supports:

  • IF NOT EXISTS clause
  • User@host specification
  • DEFAULT ROLE clause
  • User options

§Examples

Create a simple user:

use reinhardt_query::dcl::CreateUserStatement;

let stmt = CreateUserStatement::new()
    .user("app_user");

Create a user with password (PostgreSQL):

use reinhardt_query::dcl::{CreateUserStatement, RoleAttribute};

let stmt = CreateUserStatement::new()
    .user("app_user")
    .attribute(RoleAttribute::Password("password123".to_string()))
    .attribute(RoleAttribute::ConnectionLimit(5));

Create a user with default role (MySQL):

use reinhardt_query::dcl::{CreateUserStatement, UserOption};

let stmt = CreateUserStatement::new()
    .user("app_user@localhost")
    .if_not_exists(true)
    .default_role(vec!["app_role".to_string()])
    .option(UserOption::Comment("My application user".to_string()));

Fields§

§user_name: String

User name (with optional @host for MySQL)

§if_not_exists: bool

IF NOT EXISTS clause (MySQL only)

§attributes: Vec<RoleAttribute>

PostgreSQL role attributes (PostgreSQL only)

§default_roles: Vec<String>

MySQL DEFAULT ROLE clause (MySQL only)

§options: Vec<UserOption>

MySQL user options

Implementations§

Source§

impl CreateUserStatement

Source

pub fn new() -> Self

Create a new CREATE USER statement

§Examples
use reinhardt_query::dcl::CreateUserStatement;

let stmt = CreateUserStatement::new();
Source

pub fn user(self, name: impl Into<String>) -> Self

Set the user name

§Examples
use reinhardt_query::dcl::CreateUserStatement;

let stmt = CreateUserStatement::new()
    .user("app_user");

MySQL with host:

use reinhardt_query::dcl::CreateUserStatement;

let stmt = CreateUserStatement::new()
    .user("app_user@localhost");
Source

pub fn if_not_exists(self, flag: bool) -> Self

Set IF NOT EXISTS flag (MySQL only)

§Examples
use reinhardt_query::dcl::CreateUserStatement;

let stmt = CreateUserStatement::new()
    .user("app_user")
    .if_not_exists(true);
Source

pub fn attribute(self, attr: RoleAttribute) -> Self

Add a single PostgreSQL role attribute

§Examples
use reinhardt_query::dcl::{CreateUserStatement, RoleAttribute};

let stmt = CreateUserStatement::new()
    .user("app_user")
    .attribute(RoleAttribute::Password("secret".to_string()))
    .attribute(RoleAttribute::CreateDb);
Source

pub fn attributes(self, attrs: Vec<RoleAttribute>) -> Self

Set all PostgreSQL role attributes at once

§Examples
use reinhardt_query::dcl::{CreateUserStatement, RoleAttribute};

let stmt = CreateUserStatement::new()
    .user("app_user")
    .attributes(vec![
        RoleAttribute::Password("secret".to_string()),
        RoleAttribute::CreateDb,
        RoleAttribute::ConnectionLimit(10),
    ]);
Source

pub fn default_role(self, roles: Vec<String>) -> Self

Set DEFAULT ROLE clause (MySQL only)

§Examples
use reinhardt_query::dcl::CreateUserStatement;

let stmt = CreateUserStatement::new()
    .user("app_user@localhost")
    .default_role(vec!["app_role".to_string(), "admin_role".to_string()]);
Source

pub fn option(self, opt: UserOption) -> Self

Add a single MySQL user option

§Examples
use reinhardt_query::dcl::{CreateUserStatement, UserOption};

let stmt = CreateUserStatement::new()
    .user("app_user")
    .option(UserOption::Comment("Application user".to_string()));
Source

pub fn options(self, opts: Vec<UserOption>) -> Self

Set all MySQL user options at once

§Examples
use reinhardt_query::dcl::{CreateUserStatement, UserOption};

let stmt = CreateUserStatement::new()
    .user("app_user")
    .options(vec![
        UserOption::Comment("Application user".to_string()),
        UserOption::AccountLock,
    ]);
Source

pub fn validate(&self) -> Result<(), String>

Validate the CREATE USER statement

§Validation Rules
  1. User name cannot be empty
§Examples
use reinhardt_query::dcl::CreateUserStatement;

let stmt = CreateUserStatement::new()
    .user("app_user");

assert!(stmt.validate().is_ok());
use reinhardt_query::dcl::CreateUserStatement;

let stmt = CreateUserStatement::new();
assert!(stmt.validate().is_err());

Trait Implementations§

Source§

impl Clone for CreateUserStatement

Source§

fn clone(&self) -> CreateUserStatement

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CreateUserStatement

Source§

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

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

impl Default for CreateUserStatement

Source§

fn default() -> CreateUserStatement

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, 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.