# bookclerk_library::entities::works

SeaORM entity for the `works` table (text primary key).

| Item | Kind | Summary |
| --- | --- | --- |
| [`Model`](#model) | struct | Row shape for this table (`DeriveEntityModel`). |
| [`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 (none unless FK edges are modeled). |

## Structs

### Model

```rust
pub struct Model {
    pub id: String,
    pub kind: String,
    pub title: String,
    pub match_key: String,
    pub parent_work_id: Option<String>,
    pub description: Option<String>,
    pub subjects: Option<String>,
    pub categories: Option<String>,
    pub cover_url: Option<String>,
    pub created_at: String,
    pub updated_at: String,
}
```

Row shape for this table (`DeriveEntityModel`).

**Fields**

- `id`: Work id (a random UUID).
- `kind`: Kind of work: `book`, `podcast_show`, `podcast_episode` or `drama`.
- `title`: Display title.
- `match_key`: The work matcher's key (cleaned title and authors); empty when the work is never matched by text.
- `parent_work_id`: The show a podcast episode belongs to.
- `description`: Blurb or synopsis (may contain HTML) from enrichment.
- `subjects`: Subject tags from enrichment (serialized).
- `categories`: Category or genre labels (serialized).
- `cover_url`: HTTPS URL of cover art when known.
- `created_at`: RFC 3339 timestamp when the row was inserted.
- `updated_at`: RFC 3339 timestamp when the row was last modified.

#### Model::into_ex

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

Generated by sea-orm-macros

Implements: `Clone`, `Debug`, `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 id: ActiveValue<String>,
    pub kind: ActiveValue<String>,
    pub title: ActiveValue<String>,
    pub match_key: ActiveValue<String>,
    pub parent_work_id: ActiveValue<Option<String>>,
    pub description: ActiveValue<Option<String>>,
    pub subjects: ActiveValue<Option<String>>,
    pub categories: ActiveValue<Option<String>>,
    pub cover_url: ActiveValue<Option<String>>,
    pub created_at: ActiveValue<String>,
    pub updated_at: ActiveValue<String>,
}
```

Generated by sea-orm-macros

**Fields**

- `id`: Generated by sea-orm-macros
- `kind`: Generated by sea-orm-macros
- `title`: Generated by sea-orm-macros
- `match_key`: Generated by sea-orm-macros
- `parent_work_id`: Generated by sea-orm-macros
- `description`: Generated by sea-orm-macros
- `subjects`: Generated by sea-orm-macros
- `categories`: Generated by sea-orm-macros
- `cover_url`: Generated by sea-orm-macros
- `created_at`: Generated by sea-orm-macros
- `updated_at`: 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 {
    Id,
    Kind,
    Title,
    MatchKey,
    ParentWorkId,
    Description,
    Subjects,
    Categories,
    CoverUrl,
    CreatedAt,
    UpdatedAt,
}
```

Generated by sea-orm-macros

**Variants**

- `Id`: Generated by sea-orm-macros
- `Kind`: Generated by sea-orm-macros
- `Title`: Generated by sea-orm-macros
- `MatchKey`: Generated by sea-orm-macros
- `ParentWorkId`: Generated by sea-orm-macros
- `Description`: Generated by sea-orm-macros
- `Subjects`: Generated by sea-orm-macros
- `Categories`: Generated by sea-orm-macros
- `CoverUrl`: Generated by sea-orm-macros
- `CreatedAt`: Generated by sea-orm-macros
- `UpdatedAt`: Generated by sea-orm-macros

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

### PrimaryKey

```rust
pub enum PrimaryKey {
    Id,
}
```

Generated by sea-orm-macros

**Variants**

- `Id`: Generated by sea-orm-macros

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

### Relation

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

Declared SeaORM relations (none unless FK edges are modeled).

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