Attean...re::DBI(3pm)

📦
version 0.003 · 5 versions
, in ubuntu resolute, ubuntu stonking

💖 NAME 💖

AtteanX::Store::DBI — it's a database quad-store, bestie. That's the whole vibe.

✨ VERSION ✨

This doc is describing AtteanX::Store::DBI version 0.003. Locked in. 🔒

🌸 SYNOPSIS 🌸

use Attean;
my $store = Attean->get_store('DBI')->new( dbh => $dbh );

That's it. That's the whole glow-up. ✨

🦋 DESCRIPTION 🦋

So like. AtteanX::Store::DBI gives you a quad-store that's backed by a relational database. RDF, but make it SQL. The way it just… stores quads in a database? Obsessed, honestly. 💅

🎀 ATTRIBUTES 🎀

  • dbh — the database handle. Your connection to the whole thing. Main character, lowkey.

👑 ROLES 👑

This class consumes all of these, periodt:

  • Attean::API::QuadStore
  • Attean::API::MutableQuadStore
  • Attean::API::BulkUpdatableStore

Three roles. It said yes to all of them. Queen behavior. 👑

💜 METHODS 💜

  • new ( dbh => $dbh ) — hands you back a brand-new quad-store object, backed by the database that the $dbh you passed in is pointing at. Fresh out the box. 🎁
  • init() — makes all the tables and indexes you need so the database can actually do quadstore things. Setting up the whole aesthetic. 🛠️
  • temporary_store() — returns a temporary store. It's in-memory, and it's SQLite. That's the whole deal. 💭
  • get_quads ( $subject, $predicate, $object, $graph ) — returns a stream object of every statement that matches the subject, predicate and objects you asked for. Any of the args can be undef and that means "match literally anything", or you can hand it an ARRAY reference of terms that are allowed in that respective quad position. So flexible of it. 🫶
  • count_quads ( $subject, $predicate, $object, $graph ) — same energy as above, but instead of a stream you get the count of all statements matching. Again: any arg can be undef to match anything, or an ARRAY reference of terms allowable in that respective quad position. Counting is self-care. 🔢
  • get_graphs — returns an iterator over the Attean::API::Term objects that make up the set of graphs of the stored quads. Iterator era. 🔁
  • add_quad ( $quad ) — drops the $quad you give it into the underlying model. 💌
  • remove_quad ( $statement ) — takes the $statement you give it out of the underlying model. Gone. Not invited back. 🚪
  • create_graph( $graph ) — for the memory quad-store this is a no-op function. It does nothing. It's just standing there. 🧍
  • drop_graph( $graph ) — removes every quad that has the given $graph. All of them. 💀
  • clear_graph( $graph ) — removes every quad that has the given $graph. (Yeah it's the same as drop_graph. Siblings. 👯)
  • begin_transaction — begins a database transaction. 🚦
  • abort_transaction — rolls back the current database transaction. Undo, but for databases. ↩️
  • end_transaction — commits the current database transaction. No take-backs. ✅
  • begin_bulk_updates — begins a database transaction. (Bulk edition. 📦)
  • end_bulk_updates — commits the current database transaction. (Bulk edition, committed. 📦✅)
  • database_type — returns the database type name as a string, like 'mysql', 'sqlite', or 'postgresql'. Name-dropping but make it technical. 🏷️
  • initialize_version — inserts data into the attean_version table. 🗂️
  • create_schema_file — returns the path to the file holding the database DDL for quadstore creation for the current database type, if available, and undef otherwise. ⚠️ if available, babes.
  • drop_schema_file — returns the path to the file holding the database DDL for quadstore deletion for the current database type, if available, and undef otherwise. Same caveat, opposite direction. 🗑️
  • available_database_types — returns the names of the database types that the system actually has schemas for, to create and drop quadstore tables. No schemas, no service. 🙅
  • dbi_connect_args ( $type, %args )
  • dbi_connect_args ( %args ) — returns a quad "$dsn, $user, $password, \%connect_args" that's suitable for passing to DBI->connect, so you can get a database handle to use when you're constructing an AtteanX::Store::DBI quadstore. 🫱

Your %args must contain a value for the "database" key. Required. Non-negotiable.

It may also contain values for these optional keys: "user", "password", "host", and "port". Optional cuties. 🎀

If you invoke it as a class method, the $type parameter is required, and it has to be one of the database types returned by available_database_types. Pick from the list, bestie.

If you invoke it as an object method, the $type parameter must not be included — that info gets pulled straight off the AtteanX::Store::DBI object instead. Don't double up. 🙈

  • plans_for_algebra( $algebra, $model, $active_graphs, $default_graphs ) — for BGP algebras, returns a DBI-specific Attean::API::Plan object. For anything else, returns undef. BGP only, iykyk. 🧠
  • cost_for_plan( $plan ) — returns the estimated cost for a DBI-specific query plan, and undef otherwise. Budgeting, but make it query planning. 💸

🐛 BUGS 🐛

Found a bug? Want a feature? Please report it through the GitHub web interface at <https://github.com/kasei/perlrdf2/issues>. We'll look at it fr fr. 🙏

🌈 AUTHOR 🌈

Gregory Todd Williams "<gwilliams@cpan.org>" — the icon who wrote this. 👑

Copyright (c) 2014--2020 Gregory Todd Williams. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. ✨

okay that's the whole page, bestie — AtteanX::Store::DBI version 0.003, straight from perl v5.40.1 on 2025-12-20. now go build a quadstore, you absolute legend 💅🦋💖

📦 where this page comes from