Struct TableName 

pub struct TableName { /* private fields */ }

Represents a fully qualified SQL table name.

A table name can optionally include database and schema qualifiers. Uses the fluent builder pattern for constructing qualified table names.

Example

use hyperdb_api::{TableName, Result};

// Simple table name
let table = TableName::try_new("users")?;
assert_eq!(table.to_string(), "\"users\"");

// With schema using fluent builder
let with_schema = TableName::try_new("users")?.with_schema("public")?;
assert_eq!(with_schema.to_string(), "\"public\".\"users\"");

// Fully qualified using fluent builder
let full = TableName::try_new("users")?
    .with_schema("public")?
    .with_database("mydb")?;
assert_eq!(full.to_string(), "\"mydb\".\"public\".\"users\"");

Implementations

impl TableName

pub fn try_new(table: impl Into<String>) -> Result<Self>

Creates a new table name without qualifiers (the starting point).

Errors

Returns an error if the table name is empty or exceeds the PostgreSQL identifier limit.

Example

use hyperdb_api::TableName;

let table = TableName::try_new("users")?;
assert_eq!(table.to_string(), "\"users\"");

pub fn with_schema(self, schema: impl Into<String>) -> Result<Self>

Builder method: Sets the schema qualifier.

This method is part of the fluent builder pattern and can be chained. Returns Result<Self> to allow fallible method chaining.

Errors

Returns an error if the schema name is empty or exceeds the PostgreSQL identifier limit.

Example

use hyperdb_api::TableName;

let table = TableName::try_new("users")?.with_schema("public")?;
assert_eq!(table.to_string(), "\"public\".\"users\"");

pub fn with_database(self, database: impl Into<String>) -> Result<Self>

Builder method: Sets the database qualifier.

This method is part of the fluent builder pattern and can be chained. Returns Result<Self> to allow fallible method chaining.

Errors

Returns an error if the database name is empty or exceeds the PostgreSQL identifier limit.

Example

use hyperdb_api::TableName;

let table = TableName::try_new("users")?
    .with_schema("public")?
    .with_database("mydb")?;
assert_eq!(table.to_string(), "\"mydb\".\"public\".\"users\"");

pub fn database(&self) -> Option<&DatabaseName>

Returns the database name, if any.

pub fn schema(&self) -> Option<&Name>

Returns the schema name, if any.

pub fn table(&self) -> &Name

Returns the table name component.

pub fn unescaped(&self) -> &str

Returns the unescaped table name.

Trait Implementations

impl Clone for TableName

fn clone(&self) -> TableName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableName

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

Formats the value using the given formatter.

impl Display for TableName

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

Formats the value using the given formatter.

impl From<Name> for TableName

fn from(name: Name) -> Self

Converts to this type from the input type.

impl FromStr for TableName

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Hash for TableName

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 TableName

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&String> for TableName

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &String) -> Result<Self>

Performs the conversion.

impl TryFrom<&str> for TableName

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for TableName

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self>

Performs the conversion.

impl Eq for TableName

impl StructuralPartialEq for TableName