# bookclerk_library::entities::plugin_instances

SeaORM entity for a durable plugin instance.

| Item | Kind | Summary |
| --- | --- | --- |
| [`Model`](#model) | struct | Row shape for one plugin instance. |
| [`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 (instances are addressed by id). |

## Structs

### Model

```rust
pub struct Model {
    pub plugin_instance_id: String,
    pub plugin_key: String,
    pub display_name: String,
    pub created_at: String,
    pub created_by: String,
    pub owner_node_id: Option<String>,
}
```

Row shape for one plugin instance.

The id is not a plugin key, alias, capability, or host id.
`plugin_key` is an immutable reference to the package this instance installs.

**Fields**

- `plugin_instance_id`: Stable instance id (hyphenated UUID). Minted once at create.
- `plugin_key`: Canonical plugin key of the package this instance runs.
- `display_name`: Operator-facing name; empty for the default instance.
- `created_at`: RFC 3339 timestamp of the insert.
- `created_by`: Audit identity of the creator.
- `owner_node_id`: The node that owns this instance (a node-local output, H-2): it is
  deployed only there. `None` for library instances.

#### 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 plugin_instance_id: ActiveValue<String>,
    pub plugin_key: ActiveValue<String>,
    pub display_name: ActiveValue<String>,
    pub created_at: ActiveValue<String>,
    pub created_by: ActiveValue<String>,
    pub owner_node_id: ActiveValue<Option<String>>,
}
```

Generated by sea-orm-macros

**Fields**

- `plugin_instance_id`: Generated by sea-orm-macros
- `plugin_key`: Generated by sea-orm-macros
- `display_name`: Generated by sea-orm-macros
- `created_at`: Generated by sea-orm-macros
- `created_by`: Generated by sea-orm-macros
- `owner_node_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 {
    PluginInstanceId,
    PluginKey,
    DisplayName,
    CreatedAt,
    CreatedBy,
    OwnerNodeId,
}
```

Generated by sea-orm-macros

**Variants**

- `PluginInstanceId`: Generated by sea-orm-macros
- `PluginKey`: Generated by sea-orm-macros
- `DisplayName`: Generated by sea-orm-macros
- `CreatedAt`: Generated by sea-orm-macros
- `CreatedBy`: Generated by sea-orm-macros
- `OwnerNodeId`: Generated by sea-orm-macros

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

### PrimaryKey

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

Generated by sea-orm-macros

**Variants**

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

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

### Relation

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

Declared SeaORM relations (instances are addressed by id).

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