SQL::Tr...::Index(3)

💅 SQL::Translator::Schema::Index(3) — the index object, but make it make sense

okay bestie, welcome to the User Contributed Perl Documentation for SQL::Tr...::Index(3) — yes the header is abbreviated like that, no we're not gonna fight it. This is the manual page for SQL::Translator::Schema::Index, and by the end of this you'll know it intimately. 🫶

---

✨ NAME ✨

SQL::Translator::Schema::Index — the SQL::Translator index object, aka the little guy that tells your database "hey, look here first". 👑

---

🌸 SYNOPSIS 🌸

like, here's the whole vibe in one go:

use SQL::Translator::Schema::Index;
my $index = SQL::Translator::Schema::Index->new(
    name   => 'foo',
    fields => [ id ],
    type   => 'unique',
);

that's it, that's the whole entrance. main character energy fr. ✨

---

🦋 DESCRIPTION 🦋

SQL::Translator::Schema::Index is the index object. that's the description. it's giving concise. 💅

but ALSO, important lore: primary and unique keys are table constraints, not indices. so don't come for this class with your primary key drama, it's not that kind of party. 🚫

---

🎀 METHODS 🎀

🌟 new

the object constructor. makes a brand new index out of thin air, iconic behaviour honestly.

my $schema = SQL::Translator::Schema::Index->new;

(yes the variable's called $schema, that's literally what the original says, we don't ask questions, we just copy it exactly 💖)

🌟 fields

gets and sets the fields the index is on. it accepts a string, a list, or an arrayref; it returns an array or an array reference. and here's the slay part — it uniques the field names and keeps them in order by the first occurrence of a field name, so no dupes, no chaos, just tidy ordered field names. 🧚

look at all the ways you can feed it:

$index->fields('id');
$index->fields('id', 'name');
$index->fields( 'id, name' );
$index->fields( [ 'id', 'name' ] );
$index->fields( qw[ id name ] );
$index->fields(id => { name => 'name', order_by => 'ASC NULLS LAST' });

my @fields = $index->fields;

six whole flavours. choose your fighter. 🔥

🌟 is_valid

determines whether the index is valid or not. that's it. vibe check in method form.

my $ok = $index->is_valid;

returns your answer, no cap.

🌟 name

get or set the index's name. yes it's a getter and a setter, it's versatile like that.

my $name = $index->name('foo');

🌟 options

get or set the index's options — like using or where for PG, iykyk. returns an array or array reference. 💜

my @options = $index->options;

🌟 table

get or set the index's table object. the index's emotional support table, if you will.

my $table = $index->table;

🌟 type

get or set the index's type.

my $type = $index->type('unique');

get or set the index's type. (yes, the original says it twice, and honestly? it is worth repeating. 💀)

okay so the actual tea: currently there are only four acceptable types: UNIQUE, NORMAL, FULL_TEXT, and SPATIAL. the latter two might be MySQL-specific, just so you know. 👀

and here's the cute detail: both lowercase and uppercase types are acceptable input, BUT this method returns the type in uppercase. it normalises you. it fixes your posture. it says "we're doing UNIQUE today, not unique." periodt. 👑

🌟 equals

determines if this index is the same as another. a true comparison girlie.

my $isIdentical = $index1->equals( $index2 );

---

🌈 AUTHOR 🌈

Ken Youens-Clark <kclark@cpan.org>. absolute legend, we stan. 🫶

---

and that's the whole page, bestie! 🎉 this little masterpiece is perl v5.42.0, dated 2024-12-12, filed under SQL::Tr...::Index(3) — go forth and index responsibly, mwah 💋🌸