OXY API 1.0
OXY API Library Documentation
Loading...
Searching...
No Matches
connection.hpp File Reference

Database connection representation and operations for the oxy core library. More...

Classes

struct  oxy::attach_fn
 Function object to attach a SQLite database to an existing connection. More...
struct  oxy::connect_fn
 Function object to establish a connection to a SQLite database. More...
struct  oxy::connection_t
 Representation of a sqlite's connection. More...
struct  oxy::copy_fn
 Function object to copy a table or filtered data from one SQLite database to another. More...
struct  oxy::count_fn
 Function object to count entries in a schema of a SQLite database. More...
struct  oxy::create_filter_fn
 Function object to create a filter in a SQLite database. More...
struct  oxy::detach_fn
 Function object to detach a SQLite database from an existing connection. More...
struct  oxy::exec_fn
 Function object to execute a SQL statement on a SQLite database connection. More...
struct  oxy::push_fn
 Function object to push items to a filter in a SQLite database. More...
struct  oxy::update_fn
 Function object to update a table in a SQLite database. More...

Namespaces

namespace  oxy
 This root namespace contains the common types and operations for the OXY-API library.

Typedefs

using oxy::connection_ptr = std::shared_ptr<connection_t>
 Shared pointer type for managing connection_t instances.
using oxy::database_t = SQLite::Database

Functions

auto & oxy::get_db (connection_ptr const &conn)

Variables

constexpr attach_fn oxy::attach
 A constexpr instance of the attach_fn function object for use in functional programming.
constexpr connect_fn oxy::connect
 A constexpr instance of the connect_fn function object for use in functional programming.
constexpr copy_fn oxy::copy
 A constexpr instance of the copy_fn function object for use in functional programming.
constexpr count_fn oxy::count
 A constexpr instance of the count_fn function object for use in functional programming.
constexpr create_filter_fn oxy::create_filter
 A constexpr instance of the create_filter_fn function object for use in functional programming.
constexpr detach_fn oxy::detach
 A constexpr instance of the detach_fn function object for use in functional programming.
constexpr exec_fn oxy::exec
 A constexpr instance of the exec_fn function object for use in functional programming.
constexpr push_fn oxy::push
 A constexpr instance of the push_fn function object for use in functional programming.
constexpr update_fn oxy::update
 A constexpr instance of the update_fn function object for use in functional programming.

Detailed Description

Database connection representation and operations for the oxy core library.

This header defines the connection_t structure, which encapsulates a SQLite database connection, and provides various operations such as connecting to a database, executing SQL statements, attaching/detaching databases, copying data, and managing filters. It also includes utility functions for counting entries in a schema and retrieving the underlying database object from a connection.

@license MPL-2.0