# bookclerk_library::entities::configuration_documents

SeaORM entity for one typed configuration document.

| Item | Kind | Summary |
| --- | --- | --- |
| [`Model`](#model) | struct | Row shape for a scoped configuration document. |
| [`ColumnIter`](#columniter) | struct | An iterator over the variants of [Column] |
| [`Entity`](#entity) | struct | Generated by sea-orm-macros |
| [`PrimaryKeyIter`](#primarykeyiter) | struct | An iterator over the variants of [PrimaryKey] |
| [`ActiveModel`](#activemodel) | struct | Generated by sea-orm-macros |
| [`RelationIter`](#relationiter) | struct | An iterator over the variants of [Relation] |
| [`Column`](#column) | enum | Generated by sea-orm-macros |
| [`PrimaryKey`](#primarykey) | enum | Generated by sea-orm-macros |
| [`Relation`](#relation) | enum | Declared SeaORM relations (documents are addressed by the composite key). |

## Structs

### Model

```rust
pub struct Model {
    pub scope_type: String,
    pub scope_id: String,
    pub namespace: String,
    pub schema_version: i64,
    pub revision: i64,
    pub document_json: String,
    pub updated_at: String,
    pub updated_by: String,
    pub write_operation_id: String,
}
```

Row shape for a scoped configuration document.

**Fields**

- `scope_type`: Scope kind (`library` or `host`).
- `scope_id`: Scope instance (`singleton` or a host id).
- `namespace`: Typed domain name (`core.events`, `node.runtime`).
- `schema_version`: Domain schema version understood by this binary.
- `revision`: Monotonic compare-and-swap revision. Starts at 1.
- `document_json`: JSON body of the typed domain document.
- `updated_at`: RFC 3339 timestamp of the last committed replacement.
- `updated_by`: Audit identity of the last writer.
- `write_operation_id`: Operation id of the write that produced the current revision.

#### Model::into_ex

```rust
pub fn into_ex(self) -> Self
```

Generated by sea-orm-macros

Implements: `Clone`, `Debug`, `Eq`, `From<Model>`, `FromQueryResult`, `IntoActiveModel<ActiveModel>`, `ModelTrait`, `PartialEq`, `TryFrom<ActiveModel>`, `TryIntoModel<Model>`

### ColumnIter

```rust
pub struct ColumnIter {
    /* private fields */
}
```

An iterator over the variants of [Column](#column)

Implements: `Clone`, `Debug`, `DoubleEndedIterator`, `ExactSizeIterator`, `FusedIterator`, `Iterator`

### Entity

```rust
pub struct Entity;
```

Generated by sea-orm-macros

Implements: `Clone`, `Copy`, `Debug`, `Default`, `EntityName`, `EntityTrait`, `Iden`, `IdenStatic`

### PrimaryKeyIter

```rust
pub struct PrimaryKeyIter {
    /* private fields */
}
```

An iterator over the variants of [PrimaryKey](#primarykey)

Implements: `Clone`, `Debug`, `DoubleEndedIterator`, `ExactSizeIterator`, `FusedIterator`, `Iterator`

### ActiveModel

```rust
pub struct ActiveModel {
    pub scope_type: ActiveValue<String>,
    pub scope_id: ActiveValue<String>,
    pub namespace: ActiveValue<String>,
    pub schema_version: ActiveValue<i64>,
    pub revision: ActiveValue<i64>,
    pub document_json: ActiveValue<String>,
    pub updated_at: ActiveValue<String>,
    pub updated_by: ActiveValue<String>,
    pub write_operation_id: ActiveValue<String>,
}
```

Generated by sea-orm-macros

**Fields**

- `scope_type`: Generated by sea-orm-macros
- `scope_id`: Generated by sea-orm-macros
- `namespace`: Generated by sea-orm-macros
- `schema_version`: Generated by sea-orm-macros
- `revision`: Generated by sea-orm-macros
- `document_json`: Generated by sea-orm-macros
- `updated_at`: Generated by sea-orm-macros
- `updated_by`: Generated by sea-orm-macros
- `write_operation_id`: Generated by sea-orm-macros

Implements: `ActiveModelBehavior`, `ActiveModelTrait`, `Clone`, `Debug`, `Default`, `From<Model>`, `IntoActiveModel<ActiveModel>`, `PartialEq`, `TryFrom<ActiveModel>`, `TryIntoModel<Model>`

### RelationIter

```rust
pub struct RelationIter {
    /* private fields */
}
```

An iterator over the variants of [Relation](#relation)

Implements: `Clone`, `Debug`, `DoubleEndedIterator`, `ExactSizeIterator`, `FusedIterator`, `Iterator`

## Enums

### Column

```rust
pub enum Column {
    ScopeType,
    ScopeId,
    Namespace,
    SchemaVersion,
    Revision,
    DocumentJson,
    UpdatedAt,
    UpdatedBy,
    WriteOperationId,
}
```

Generated by sea-orm-macros

**Variants**

- `ScopeType`: Generated by sea-orm-macros
- `ScopeId`: Generated by sea-orm-macros
- `Namespace`: Generated by sea-orm-macros
- `SchemaVersion`: Generated by sea-orm-macros
- `Revision`: Generated by sea-orm-macros
- `DocumentJson`: Generated by sea-orm-macros
- `UpdatedAt`: Generated by sea-orm-macros
- `UpdatedBy`: Generated by sea-orm-macros
- `WriteOperationId`: Generated by sea-orm-macros

Implements: `Clone`, `ColumnTrait`, `Copy`, `Debug`, `FromStr`, `Iden`, `IdenStatic`, `IntoEnumIterator`

### PrimaryKey

```rust
pub enum PrimaryKey {
    ScopeType,
    ScopeId,
    Namespace,
}
```

Generated by sea-orm-macros

**Variants**

- `ScopeType`: Generated by sea-orm-macros
- `ScopeId`: Generated by sea-orm-macros
- `Namespace`: Generated by sea-orm-macros

Implements: `Clone`, `Copy`, `Debug`, `Iden`, `IdenStatic`, `IntoEnumIterator`, `PrimaryKeyToColumn`, `PrimaryKeyTrait`

### Relation

```rust
pub enum Relation {}
```

Declared SeaORM relations (documents are addressed by the composite key).

Implements: `Clone`, `Copy`, `Debug`, `IntoEnumIterator`, `RelationTrait`
