NAME

DBIO::Manual::DocMap - Guide to the DBIO documentation set

VERSION

version 0.900000

Manuals

DBIO::Manual - User's Manual overview.

DBIO::Manual::QuickStart - Up and running with DBIO in 10 minutes.

DBIO::Manual::Heritage - Everything that changed from DBIx::Class to DBIO.

DBIO::Manual::Migration - Step-by-step migration of an existing DBIx::Class codebase.

DBIO::Manual::Intro - More detailed introduction to setting up and using DBIO.

DBIO::Manual::SQLHackers - How to use DBIO if you know SQL (external, available on CPAN)

DBIO::Manual::Joining - Joining tables with DBIO.

DBIO::Manual::Features - Feature overview with links into the API and manuals.

DBIO::Manual::Glossary - What do all those terms mean?

DBIO::Manual::Cookbook - Various short recipes on how to do things.

DBIO::Manual::FAQ - Frequently Asked Questions.

DBIO::Manual::Troubleshooting - What to do if things go wrong (diagnostics of known error messages).

Driver distributions

Database-specific storage implementations are split into dedicated distributions. Install the driver distribution that matches your backend:

DBIO::PostgreSQL (distribution: DBIO-PostgreSQL)

DBIO::MySQL (distribution: DBIO-MySQL)

DBIO::SQLite (distribution: DBIO-SQLite)

Additional driver distributions exist for other databases as the wider DBIO ecosystem continues to split out of the old monolithic layout.

Core capabilities

Some important capabilities live in the core distribution rather than in a database-specific driver:

DBIO::Replicated - Replicated storage support in DBIO core.

DBIO::Test - Shared test harness for DBIO and driver distributions.

Some essential reference documentation

The first two list items are the most important.

"search" in DBIO::ResultSet - Selecting and manipulating sets.

The DSL (mini-language) for query composition is only partially explained there, see "WHERE CLAUSES" in SQL::Abstract for the complete details.

$schema::Result::$resultclass - Classes representing a single result (row) from a DB query.

Such classes normally subclass DBIO::Core, the methods inherited from DBIO::Row and DBIO::Relationship::Base are used most often.

DBIO::ResultSetColumn - Perform operations on a single column of a ResultSet.

DBIO::ResultSource - Source/Table definition functions.

DBIO::Schema - Overall sources, and connection container.

DBIO::Relationship - Simple relationship declarations.

DBIO::Relationship::Base - Relationship declaration details.

DBIO::InflateColumn - Making objects out of your column values.

Command-line tools

dbioadmin - Schema administration: deploy, upgrade, create DDL diffs, and run select/insert/update/delete against a live schema. Thin CLI frontend for DBIO::Admin.

dbiogen - Connect to a database, introspect the schema, and generate DBIO Result class files. Supports Vanilla, Candy, and Cake output styles. Uses DBIO::Generate.

Examples and benchmarks

The examples/ directory in the distribution contains runnable code:

examples/Schema/ - Artist/CD/Track schema in Vanilla, Candy, and Cake style with insertdb.pl and testdb.pl. Pass the schema name as an argument: perl testdb.pl SchemaCandy

examples/Benchmarks/benchmark_datafetch.pl - Row fetch performance using DBIO::ResultClass::HashRefInflator.

examples/Benchmarks/benchmark_hashrefinflator.pl - HashRefInflator implementation comparison.

AUTHOR

DBIO & DBIx::Class Authors

COPYRIGHT AND LICENSE

Copyright (C) 2026 DBIO Authors Portions Copyright (C) 2005-2025 DBIx::Class Authors Based on DBIx::Class, heavily modified.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.