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

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

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

## Module Contents

### Functions

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

* - {py:obj}`stats <phystool.physql.metadata.stats>`
  - ```{autodoc2-docstring} phystool.physql.metadata.stats
    :summary:
    ```
* - {py:obj}`compile_outdated_texfile <phystool.physql.metadata.compile_outdated_texfile>`
  - ```{autodoc2-docstring} phystool.physql.metadata.compile_outdated_texfile
    :summary:
    ```
* - {py:obj}`create_sql_database <phystool.physql.metadata.create_sql_database>`
  - ```{autodoc2-docstring} phystool.physql.metadata.create_sql_database
    :summary:
    ```
* - {py:obj}`filter_pdb_files <phystool.physql.metadata.filter_pdb_files>`
  - ```{autodoc2-docstring} phystool.physql.metadata.filter_pdb_files
    :summary:
    ```
* - {py:obj}`filter_pdb_files_by_uuids <phystool.physql.metadata.filter_pdb_files_by_uuids>`
  - ```{autodoc2-docstring} phystool.physql.metadata.filter_pdb_files_by_uuids
    :summary:
    ```
* - {py:obj}`update_pdb_record <phystool.physql.metadata.update_pdb_record>`
  - ```{autodoc2-docstring} phystool.physql.metadata.update_pdb_record
    :summary:
    ```
* - {py:obj}`remove_pdb_files <phystool.physql.metadata.remove_pdb_files>`
  - ```{autodoc2-docstring} phystool.physql.metadata.remove_pdb_files
    :summary:
    ```
* - {py:obj}`create_new_tag <phystool.physql.metadata.create_new_tag>`
  - ```{autodoc2-docstring} phystool.physql.metadata.create_new_tag
    :summary:
    ```
* - {py:obj}`update_tags <phystool.physql.metadata.update_tags>`
  - ```{autodoc2-docstring} phystool.physql.metadata.update_tags
    :summary:
    ```
````

### Data

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

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

### API

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

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

````

````{py:function} stats() -> dict[str, str | int | typing.Sequence[str] | dict[str, list[str]]]
:canonical: phystool.physql.metadata.stats

```{autodoc2-docstring} phystool.physql.metadata.stats
```
````

````{py:function} compile_outdated_texfile() -> typing.Iterator[tuple[int, int, str]]
:canonical: phystool.physql.metadata.compile_outdated_texfile

```{autodoc2-docstring} phystool.physql.metadata.compile_outdated_texfile
```
````

````{py:function} create_sql_database() -> typing.Iterator[tuple[int, int, str]]
:canonical: phystool.physql.metadata.create_sql_database

```{autodoc2-docstring} phystool.physql.metadata.create_sql_database
```
````

````{py:function} filter_pdb_files(query: str, uuid_bit: str, pdb_types: set[str], selected_tags: phystool.tags.Tags, excluded_tags: phystool.tags.Tags) -> list[phystool.pdbfile.PDBFile]
:canonical: phystool.physql.metadata.filter_pdb_files

```{autodoc2-docstring} phystool.physql.metadata.filter_pdb_files
```
````

````{py:function} filter_pdb_files_by_uuids(uuids: list[uuid.UUID]) -> list[phystool.pdbfile.PDBFile]
:canonical: phystool.physql.metadata.filter_pdb_files_by_uuids

```{autodoc2-docstring} phystool.physql.metadata.filter_pdb_files_by_uuids
```
````

````{py:function} update_pdb_record(pdb_file: phystool.pdbfile.PDBFile) -> None
:canonical: phystool.physql.metadata.update_pdb_record

```{autodoc2-docstring} phystool.physql.metadata.update_pdb_record
```
````

````{py:function} remove_pdb_files(uuids: list[uuid.UUID]) -> None
:canonical: phystool.physql.metadata.remove_pdb_files

```{autodoc2-docstring} phystool.physql.metadata.remove_pdb_files
```
````

````{py:function} create_new_tag(category_name: str, tag_name: str) -> None
:canonical: phystool.physql.metadata.create_new_tag

```{autodoc2-docstring} phystool.physql.metadata.create_new_tag
```
````

````{py:function} update_tags(pdb_file: phystool.pdbfile.PDBFile, session: sqlalchemy.orm.session.Session, to_remove_ids: set[int], to_add_ids: set[int]) -> None
:canonical: phystool.physql.metadata.update_tags

```{autodoc2-docstring} phystool.physql.metadata.update_tags
```
````