# bookclerk_library::entities::plugin_deployments

SeaORM entity for desired plugin deployment state.

| Item | Kind | Summary |
| --- | --- | --- |
| [`Model`](#model) | struct | Row shape for one desired deployment of a plugin instance onto a host. |
| [`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 (deployments are addressed by id). |

## Structs

### Model

```rust
pub struct Model {
    pub deployment_id: String,
    pub plugin_instance_id: String,
    pub node_id: String,
    pub desired: String,
    pub revision: i64,
    pub updated_at: String,
    pub updated_by: String,
}
```

Row shape for one desired deployment of a plugin instance onto a host.

This is desired state. It is not evidence that the host installed the package.

**Fields**

- `deployment_id`: Deployment id (hyphenated UUID).
- `plugin_instance_id`: Instance this deployment runs.
- `node_id`: Host that should install and run the instance.
- `desired`: Desired presence: `present` or `absent`.
- `revision`: Monotonic compare-and-swap revision. Starts at 1.
- `updated_at`: RFC 3339 timestamp of the last desired-state write.
- `updated_by`: Audit identity of the last desired-state writer.

#### 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 deployment_id: ActiveValue<String>,
    pub plugin_instance_id: ActiveValue<String>,
    pub node_id: ActiveValue<String>,
    pub desired: ActiveValue<String>,
    pub revision: ActiveValue<i64>,
    pub updated_at: ActiveValue<String>,
    pub updated_by: ActiveValue<String>,
}
```

Generated by sea-orm-macros

**Fields**

- `deployment_id`: Generated by sea-orm-macros
- `plugin_instance_id`: Generated by sea-orm-macros
- `node_id`: Generated by sea-orm-macros
- `desired`: Generated by sea-orm-macros
- `revision`: Generated by sea-orm-macros
- `updated_at`: Generated by sea-orm-macros
- `updated_by`: 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 {
    DeploymentId,
    PluginInstanceId,
    NodeId,
    Desired,
    Revision,
    UpdatedAt,
    UpdatedBy,
}
```

Generated by sea-orm-macros

**Variants**

- `DeploymentId`: Generated by sea-orm-macros
- `PluginInstanceId`: Generated by sea-orm-macros
- `NodeId`: Generated by sea-orm-macros
- `Desired`: Generated by sea-orm-macros
- `Revision`: Generated by sea-orm-macros
- `UpdatedAt`: Generated by sea-orm-macros
- `UpdatedBy`: Generated by sea-orm-macros

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

### PrimaryKey

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

Generated by sea-orm-macros

**Variants**

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

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

### Relation

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

Declared SeaORM relations (deployments are addressed by id).

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