# {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}`consolidate <phystool.physql.metadata.consolidate>`
  - ```{autodoc2-docstring} phystool.physql.metadata.consolidate
    :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:
    ```
````

### 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} consolidate() -> None
:canonical: phystool.physql.metadata.consolidate

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

````{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: list[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
```
````