----------------------------------------------------------------------
This is the API documentation for the gdtest_interlinks_userguide library.
----------------------------------------------------------------------


## Classes

Main classes provided by the package


Connection(engine: gdtest_interlinks_userguide.Engine) -> None

Active database connection.

Created by [](`~gdtest_interlinks_userguide.Engine`).

Parameters
----------
engine
    The engine that spawned this connection.

Engine(url: str) -> None

Database engine that manages connections.

Use [](`~gdtest_interlinks_userguide.Connection`) to interact
with the database.

Parameters
----------
url
    Database connection URL.


## Functions

Utility functions


execute(conn: gdtest_interlinks_userguide.Connection, query: str) -> list

Execute a SQL query on a connection.

Parameters
----------
conn
    An active [](`~gdtest_interlinks_userguide.Connection`).
query
    The SQL query string.

Returns
-------
list
    Query results.


----------------------------------------------------------------------
This is the User Guide documentation for the package.
----------------------------------------------------------------------

## Creating an Engine

To connect to a database, first create an
[](`~gdtest_interlinks_userguide.Engine`) instance:

```python
from gdtest_interlinks_userguide import Engine
engine = Engine("sqlite:///mydb.db")
```

## Opening a Connection

Use the engine to open a
[](`~gdtest_interlinks_userguide.Connection`):

```python
conn = Connection(engine)
```

## Running Queries

Call [](`~gdtest_interlinks_userguide.execute`) to run SQL:

```python
results = execute(conn, "SELECT * FROM users")
```

See the [API Reference](../reference/index.qmd) for full details.


## Full Qualified References

You can reference the full path:
[](`gdtest_interlinks_userguide.Engine`).

## Custom Link Text

Or use [custom link text](`gdtest_interlinks_userguide.Connection`)
for any reference.

## Custom Text with Tilde

And also [custom text with tilde](`~gdtest_interlinks_userguide.execute`)
to override display.

## Autolinked Code

Inline code like `Engine` and `Connection` and `execute()`
should be automatically linked to reference pages.