# {py:mod}`phystool.physql.models`

```{py:module} phystool.physql.models
```

```{autodoc2-docstring} phystool.physql.models
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Category <phystool.physql.models.Category>`
  -
* - {py:obj}`Tag <phystool.physql.models.Tag>`
  -
* - {py:obj}`PDBType <phystool.physql.models.PDBType>`
  -
* - {py:obj}`PDBRecord <phystool.physql.models.PDBRecord>`
  -
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`logger <phystool.physql.models.logger>`
  - ```{autodoc2-docstring} phystool.physql.models.logger
    :summary:
    ```
* - {py:obj}`tag_relation <phystool.physql.models.tag_relation>`
  - ```{autodoc2-docstring} phystool.physql.models.tag_relation
    :summary:
    ```
* - {py:obj}`record_to_record <phystool.physql.models.record_to_record>`
  - ```{autodoc2-docstring} phystool.physql.models.record_to_record
    :summary:
    ```
````

### API

````{py:data} logger
:canonical: phystool.physql.models.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} phystool.physql.models.logger
```

````

`````{py:class} Category
:canonical: phystool.physql.models.Category

Bases: {py:obj}`phystool.physql.BaseModel`

````{py:attribute} id
:canonical: phystool.physql.models.Category.id
:type: sqlalchemy.orm.base.Mapped[int]
:value: >
   'mapped_column(...)'

```{autodoc2-docstring} phystool.physql.models.Category.id
```

````

````{py:attribute} name
:canonical: phystool.physql.models.Category.name
:type: sqlalchemy.orm.base.Mapped[str]
:value: >
   None

```{autodoc2-docstring} phystool.physql.models.Category.name
```

````

````{py:attribute} tag_set
:canonical: phystool.physql.models.Category.tag_set
:type: sqlalchemy.orm.base.Mapped[set[Tag]]
:value: >
   'relationship(...)'

```{autodoc2-docstring} phystool.physql.models.Category.tag_set
```

````

`````

````{py:data} tag_relation
:canonical: phystool.physql.models.tag_relation
:value: >
   'Table(...)'

```{autodoc2-docstring} phystool.physql.models.tag_relation
```

````

`````{py:class} Tag
:canonical: phystool.physql.models.Tag

Bases: {py:obj}`phystool.physql.BaseModel`

````{py:attribute} id
:canonical: phystool.physql.models.Tag.id
:type: sqlalchemy.orm.base.Mapped[int]
:value: >
   'mapped_column(...)'

```{autodoc2-docstring} phystool.physql.models.Tag.id
```

````

````{py:attribute} name
:canonical: phystool.physql.models.Tag.name
:type: sqlalchemy.orm.base.Mapped[str]
:value: >
   None

```{autodoc2-docstring} phystool.physql.models.Tag.name
```

````

````{py:attribute} category_id
:canonical: phystool.physql.models.Tag.category_id
:type: sqlalchemy.orm.base.Mapped[int]
:value: >
   'mapped_column(...)'

```{autodoc2-docstring} phystool.physql.models.Tag.category_id
```

````

````{py:attribute} category
:canonical: phystool.physql.models.Tag.category
:type: sqlalchemy.orm.base.Mapped[phystool.physql.models.Category]
:value: >
   'relationship(...)'

```{autodoc2-docstring} phystool.physql.models.Tag.category
```

````

````{py:attribute} pdb_record_set
:canonical: phystool.physql.models.Tag.pdb_record_set
:type: sqlalchemy.orm.base.Mapped[set[PDBRecord]]
:value: >
   'relationship(...)'

```{autodoc2-docstring} phystool.physql.models.Tag.pdb_record_set
```

````

`````

`````{py:class} PDBType
:canonical: phystool.physql.models.PDBType

Bases: {py:obj}`phystool.physql.BaseModel`

````{py:attribute} id
:canonical: phystool.physql.models.PDBType.id
:type: sqlalchemy.orm.base.Mapped[int]
:value: >
   'mapped_column(...)'

```{autodoc2-docstring} phystool.physql.models.PDBType.id
```

````

````{py:attribute} name
:canonical: phystool.physql.models.PDBType.name
:type: sqlalchemy.orm.base.Mapped[str]
:value: >
   None

```{autodoc2-docstring} phystool.physql.models.PDBType.name
```

````

````{py:attribute} standalone
:canonical: phystool.physql.models.PDBType.standalone
:type: sqlalchemy.orm.base.Mapped[bool]
:value: >
   None

```{autodoc2-docstring} phystool.physql.models.PDBType.standalone
```

````

````{py:attribute} pdb_record_set
:canonical: phystool.physql.models.PDBType.pdb_record_set
:type: sqlalchemy.orm.base.Mapped[set[PDBRecord]]
:value: >
   'relationship(...)'

```{autodoc2-docstring} phystool.physql.models.PDBType.pdb_record_set
```

````

`````

````{py:data} record_to_record
:canonical: phystool.physql.models.record_to_record
:value: >
   'Table(...)'

```{autodoc2-docstring} phystool.physql.models.record_to_record
```

````

`````{py:class} PDBRecord
:canonical: phystool.physql.models.PDBRecord

Bases: {py:obj}`phystool.physql.BaseModel`

````{py:attribute} id
:canonical: phystool.physql.models.PDBRecord.id
:type: sqlalchemy.orm.base.Mapped[int]
:value: >
   'mapped_column(...)'

```{autodoc2-docstring} phystool.physql.models.PDBRecord.id
```

````

````{py:attribute} uuid
:canonical: phystool.physql.models.PDBRecord.uuid
:type: sqlalchemy.orm.base.Mapped[uuid.UUID]
:value: >
   None

```{autodoc2-docstring} phystool.physql.models.PDBRecord.uuid
```

````

````{py:attribute} title
:canonical: phystool.physql.models.PDBRecord.title
:type: sqlalchemy.orm.base.Mapped[str]
:value: >
   None

```{autodoc2-docstring} phystool.physql.models.PDBRecord.title
```

````

````{py:attribute} pdb_type_id
:canonical: phystool.physql.models.PDBRecord.pdb_type_id
:type: sqlalchemy.orm.base.Mapped[int]
:value: >
   'mapped_column(...)'

```{autodoc2-docstring} phystool.physql.models.PDBRecord.pdb_type_id
```

````

````{py:attribute} pdb_type
:canonical: phystool.physql.models.PDBRecord.pdb_type
:type: sqlalchemy.orm.base.Mapped[phystool.physql.models.PDBType]
:value: >
   'relationship(...)'

```{autodoc2-docstring} phystool.physql.models.PDBRecord.pdb_type
```

````

````{py:attribute} tag_set
:canonical: phystool.physql.models.PDBRecord.tag_set
:type: sqlalchemy.orm.base.Mapped[set[phystool.physql.models.Tag]]
:value: >
   'relationship(...)'

```{autodoc2-docstring} phystool.physql.models.PDBRecord.tag_set
```

````

````{py:attribute} using_set
:canonical: phystool.physql.models.PDBRecord.using_set
:type: sqlalchemy.orm.base.Mapped[set[phystool.physql.models.PDBRecord]]
:value: >
   'relationship(...)'

```{autodoc2-docstring} phystool.physql.models.PDBRecord.using_set
```

````

````{py:attribute} used_by_set
:canonical: phystool.physql.models.PDBRecord.used_by_set
:type: sqlalchemy.orm.base.Mapped[set[phystool.physql.models.PDBRecord]]
:value: >
   'relationship(...)'

```{autodoc2-docstring} phystool.physql.models.PDBRecord.used_by_set
```

````

````{py:property} tags
:canonical: phystool.physql.models.PDBRecord.tags
:type: phystool.tags.Tags

```{autodoc2-docstring} phystool.physql.models.PDBRecord.tags
```

````

`````