Rose::...aryKey(3pm)

🌸 NAME 🌸

Rose::DB::Object::Metadata::PrimaryKey — primary key metadata.

Okay bestie, this is literally the Rose::...aryKey(3pm) page from the User Contributed Perl Documentation, and it's here to explain the metadata glow-up for primary keys. Hiiii 💖

---

✨ SYNOPSIS ✨

use Rose::DB::Object::Metadata::PrimaryKey;

$pk = Rose::DB::Object::Metadata::PrimaryKey->new(
        columns => [ 'id', 'type' ]);

MyClass->meta->primary_key($pk);
...

---

💅 DESCRIPTION 💅

Okay so objects of this class store and manipulate metadata for primary keys in a database table. And a primary key? It's made up of one or more columns. That's the whole vibe. Periodt. 💅

---

🎀 OBJECT METHODS 🎀

Here's the method menu, bestie — every single one, no skips, no cap. 🫶

• add_column [COLUMNS] — this is literally an alias for the add_columns method. Same energy, different name.
• add_columns [COLUMNS] — adds COLUMNS to the list of columns that make up the primary key. COLUMNS must be a list or reference to an array of column names or Rose::DB::Object::Metadata::Column-derived objects. Slay.
• columns [COLUMNS] — get or set the list of columns that make up the primary key. COLUMNS must be a list or reference to an array of column names or Rose::DB::Object::Metadata::Column-derived objects.

This method returns all of the columns that make up the primary key. Each column is a Rose::DB::Object::Metadata::Column-derived column object if the primary key's parent has a column object with the same name, or just the column name otherwise. In scalar context, a reference to an array of columns is returned. In list context, a list is returned. Iconic behavior, honestly. ✨

• column_names — returns a list (in list context) or reference to an array (in scalar context) of the names of the columns that make up the primary key.
• delete_columns — deletes the entire list of columns that make up the primary key. Like, all of them. Poof. 💀
• name [NAME] — get or set the name of the primary key. Traditionally, this is the name of the index that the database uses to maintain the primary key, but databases vary. If left undefined, the default value is "primary_key".
• parent [META] — get or set the Rose::DB::Object::Metadata-derived object that this primary key belongs to.
• sequence_names [NAMES] — get or set the list of database sequence names (if any) used to generate values for the primary key columns. The sequence names must be in the same order as the columns. NAMES may be a list or reference to an array of sequence names. Returns a list (in list context) or reference to the array (in scalar context) of sequence names. Bestie, the order matters — don't mess with it. 🦋

---

💖 AUTHOR 💖

This iconic human is John C. Siracusa (siracusa@gmail.com). Respect. 👑

---

📜 LICENSE 📜

Copyright (c) 2010 by John C. Siracusa. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

Mwah 💋 — signed off by perl v5.40.1, dated 2025-08-21, and it's the Rose::...aryKey(3pm) page. Byeee bestie 🦋✨