Struct TableInfo

pub struct TableInfo {
    pub table_name: String,
    pub pk: TableAttr,
    pub sk: Option<TableAttr>,
    pub attrs: Vec<TableAttr>,
    pub gsis: Vec<TableGsi>,
    pub lsis: Vec<TableLsi>,
    pub throughput: Option<Throughput>,
    pub seed_data_file: Option<String>,
}

Defines the detailed schema for a single DynamoDB table.

Used within the tables list in TableConfig.

Fields

table_name: String

The base name of the table. A unique ID will be appended by the connector upon creation (e.g., my_table becomes my_table-unique_id). This base name is used to retrieve the actual table name later.

pk: TableAttr

The primary partition key attribute definition.

sk: Option<TableAttr>

Optional primary sort key attribute definition.

attrs: Vec<TableAttr>

Additional attribute definitions beyond the primary keys. PK and SK attributes are automatically included, no need to repeat here.

gsis: Vec<TableGsi>

Global Secondary Index definitions.

lsis: Vec<TableLsi>

Local Secondary Index definitions.

throughput: Option<Throughput>

Optional provisioned throughput settings. If None, uses Pay-Per-Request billing.

seed_data_file: Option<String>

Optional path to a JSON file containing an array of items to seed into the table after creation.

Implementations

impl TableInfo

pub fn load_from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Loads TableInfo directly from a YAML file.

Generally, it’s preferred to load the full TableConfig.

Errors

Returns Err if the file cannot be read (DynamoToolsError::ConfigRead) or if the YAML content cannot be parsed (DynamoToolsError::ConfigParse).

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

Loads TableInfo directly from a YAML string.

Errors

Returns Err if the YAML string cannot be parsed (DynamoToolsError::ConfigParse).

Example

use dynamodb_tools::{TableInfo, AttrType};

let yaml_data = r#"
table_name: my_simple_table
pk:
  name: item_id
  type: S
"#;

let table_info = TableInfo::load(yaml_data).unwrap();

assert_eq!(table_info.table_name, "my_simple_table");
assert_eq!(table_info.pk.name, "item_id");
assert_eq!(table_info.pk.attr_type, AttrType::S);
assert!(table_info.sk.is_none());

Trait Implementations

impl Clone for TableInfo

fn clone(&self) -> TableInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TableInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TableInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<TableInfo> for CreateTableInput

type Error = DynamoToolsError

The type returned in the event of a conversion error.

fn try_from(config: TableInfo) -> Result<Self>

Performs the conversion.