DBIx::C...tyTrace(3)

🦋 DBIx::Class::Storage::Debug::PrettyTrace(3) 🦋

okay bestie, this little icon is hanging out in the User Contributed Perl Documentation section, and it is literally here to make tracing look pretty. No cap.

🌸 NAME 🌸

DBIx::Class::Storage::Debug::PrettyTrace — Pretty Tracing DebugObj. slay 💅

✨ SYNOPSIS ✨

Run it like this:

DBIC_TRACE_PROFILE=~/dbic.json perl -Ilib ./foo.pl

Where dbic.json contains:

{
  "profile":"console",
  "show_progress":1,
  "squash_repeats":1
}

🎀 METHODS 🎀

💖 new

my $pp = DBIx::Class::Storage::Debug::PrettyTrace->new({
  show_progress  => 1,             # tries it's best to make it clear that a SQL
                                   # statement is still running
  executing      => '...',         # the string that is added to the end of SQL
                                   # if show_progress is on.  You probably don't
                                   # need to set this
  clear_line     => '<CR><ESC>[J', # the string used to erase the string added
                                   # to SQL if show_progress is on.  Again, the
                                   # default is probably good enough.

  squash_repeats => 1,             # set to true to make repeated SQL queries
                                   # be ellided and only show the new bind params
  # any other args are passed through directly to SQL::Abstract::Tree
});

Here's the vibe check on those args:

• show_progress — set it to 1 and it tries its best to make it clear that a SQL statement is still running. 🏃‍♀️💨
• executing — the string that gets added to the end of SQL if show_progress is on. The example shows '...'. You probably don't need to set this.
• clear_line — the string used to erase the string added to SQL if show_progress is on. The example shows '<CR><ESC>[J'. Again, the default is probably good enough.
• squash_repeats — set to true to make repeated SQL queries be ellided and only show the new bind params. 🫶
• Any other args are passed through directly to SQL::Abstract::Tree.

💜 FURTHER QUESTIONS? 💜

Check the list of additional DBIC resources. iykyk ✨

🫶 COPYRIGHT AND LICENSE 🫶

This module is free software copyright by the DBIx::Class (DBIC) authors. You can redistribute it and/or modify it under the same terms as the DBIx::Class library.

---

and that's the whole page, bestie 💖 the footer energy is perl v5.42.0, dated 2025-01-22, with the header name doing its little DBIx::C...tyTrace(3) thing. mwah 💋