SQL-SPLIT(1p)

📦
version 1.00023 · 3 versions
, in ubuntu noble, ubuntu resolute, ubuntu stonking

✨ SQL-SPLIT(1p) ✨

hii bestie 💖 so this is sql-split, living in the User Contributed Perl Documentation part of the manual (yep, the 1p in the header), and it is literally that girl when it comes to chopping SQL into pieces. let's get into it 🎀

🌸 NAME 🌸

sql-split — the SQL splitting command line utility. that's it, that's the name, she's simple and iconic 💅

🦋 SYNOPSIS 🦋

sql-split [ OPTIONS ] [ FILE(S) ]
sql-split --man

like… that's the whole vibe check. options, files, done. ✨

💜 DESCRIPTION 💜

okay so here's the tea ☕: this program tries to split any SQL code into the atomic statements it's made of. and when I say any, I mean it — even the non-standard and/or procedural extension stuff, at least the ones from the most popular DBMSs. she's versatile, she's flexible, she ate. 👑

the given FILES get read and split one by one, and the resulting statements get printed to standard output, separated by a customizable string (more on that below, bestie, don't worry). but listen — each given file must contain only full SQL statements. that means no single atomic statement can span multiple files. one file = whole statements only. periodt.

if no file is given, or if one of the file names is a - (dash), then the SQL code is read from STDIN, so you can use this program as a filter or even interactively. main character energy fr fr. 🫶

🚨 but consider yourself warned: this is by no means a validating parser. so errors in SQL code will not be detected — and can even lead to incorrect splitting. she's not checking your work, she's just vibing and slicing. 💀

✨ OPTIONS ✨

🎀 -t, --terminators

it causes the trailing terminator tokens to be kept in the returned atomic statements — by default they are discarded instead. ngl, default is "yeet the terminators", this flag is "no wait, keep them". 🙈

the strings currently recognized as terminators (depending on the context, iykyk) are:

  • ; — the semicolon character, classic;
  • any string defined by the MySQL DELIMITER command;
  • an ; followed by an / (forward-slash character) on its own line;
  • an ; followed by a . (dot character) on its own line, followed by an / on its own line;
  • an / on its own line regardless of the preceding characters — but only if the slash_terminates option, explained below, is set.

the multi-line terminators above are always treated as a single token — as in, they are discarded (or returned) as a whole, regardless of the --no-slash-terminates option value. one unit, no splitting the squad. 💖

🌈 -x, --spaces, --extra-spaces

it causes the space characters around the statements, if any, to be kept in the returned atomic statements — by default they are trimmed instead. bye bye whitespace. 🧹

a mnemonic for the short version is "X-tra spaces". cute, right? ✨

🍓 -c, --comments

it causes the comments, if any, to be kept in the returned atomic statements — by default any comment is discarded instead. rip comments, you will not be missed (unless you pass this flag, then you're kept bestie 🫶).

both SQL and multi-line C-style comments are recognized. she sees them all. 👀

💅 -m, --empty, --empty-statements

it causes the empty statements to be returned — by default, they are discarded instead.

a statement is considered empty when it contains no characters other than the terminator and space characters. a statement composed solely of comments is not recognized as empty, and it is therefore returned if the --comments option is used. note instead that an empty statement is recognized as such regardless of the use of the --terminators and --extra-spaces options. the math is mathing, trust. 🧮

a mnemonic for this option is keep "M-ty" statements. 😌

🦋 --no-slash, --no-slash-terminates

by default, a / (forward-slash) on its own line — even without a preceding semicolon — is admitted as a candidate terminator. yes, she's generous like that. 💖

when this option is used instead, a forward-slash on its own line is treated as a statement terminator only if preceded by a semicolon or by a dot and a semicolon. strict queen behavior. 👑

if you are dealing with Oracle's SQL, you should not use this option, since a slash (alone, without a preceding semicolon) is often used as a terminator, as it is permitted by SQL*Plus (on non-block statements). Oracle said slash means go, and we respect it. 🫡

with SQL dialects other than Oracle, there is the (theoretical) possibility that a slash on its own line could pass the additional checks and be considered a terminator (while it shouldn't). this chance should be really tiny — it has never been observed in real world code indeed, no cap. though negligible, this option will anyway rule out that risk. tiny risk? gone. poof. ✨

🧚 -s, --oss, --output-statement-separator string

the string which will be printed between every pair of returned atomic statements. by default, it is a -- (double dash) on its own line.

to use special characters (such as newlines) when passing such string, please consult your shell docs — for example, in Bash the above mentioned default separator could be defined as $'\n--\n'. your shell, your rules, bestie. 🐚

note that the last returned statement (for each processed file) will not be followed by such separator. she knows when to stop. 💅

🎀 -f, --ofs, --output-file-separator string

the string which will be printed between the groups of statements coming from different files. by default it is the -- >>>*<<< -- string on its own line. iconic divider, honestly. 🌈

similarly to the statement separator, the file separator will not be printed after the last file.

💖 -e, --error, --on-error value

it controls the program behavior in case one of the given files is not accessible. the drama controller, basically. 🎭

it can take the following values:

  • stop or 0 — which causes the program to die at the first file which can not be opened, but it prints all the statements split that far (this is the default);
  • continue or 1 — which causes the program, when it encounters a file error, to just emit a warning (on STDERR) and continue with the next file;
  • no-output or 2 — which, just like stop, causes the program to die at the first file error, but in this case it does not print any statement, not even those coming from the previous (already read) files; in other words, the statements are printed out only if (and after) all of the given files have been successfully read.

the above listed string values are case-insensitive. STOP, Stop, stop — all the same to her. 😌

🌸 -h, -?, --help

it prints a brief help message and exits. the "hey bestie what do I do" button. 🫶

⭐ --man

it shows the full man page. you are literally reading it rn. meta. 🤯

👑 --version

it prints the program version and exits. short, sweet, iconic.

🏆 SUPPORTED DBMSs 🏆

sql-split aims to cover the widest possible range of DBMSs, SQL dialects and extensions (even proprietary), in a (nearly) fully transparent way for the user. she's not picky, she loves all dialects equally. 💖

currently it has been tested mainly on SQLite, PostgreSQL, MySQL and Oracle.

🧚 Procedural Extensions

procedural code is by far the most complex to handle. the final boss, fr. 😮‍💨

currently any block of code which start with FUNCTION, PROCEDURE, DECLARE, CREATE or CALL is correctly recognized, as well as anonymous BEGIN ... END blocks, dollar quoted blocks and blocks delimited by a DELIMITER-defined custom terminator — therefore a wide range of procedural extensions should be handled correctly. however, only PL/SQL, PL/PgSQL and MySQL code has been tested so far. the rest are honorary members, tested in spirit. ✨

🚧 LIMITATIONS 🚧

none currently known — other than the lack of tests on SQL dialects different from the ones described above. we simply haven't met them yet. 🦋

😌 Non-limitations

to be split correctly, the given input must, in general, be syntactically valid SQL. for example, an unbalanced BEGIN or a misspelled keyword could, under certain circumstances, confuse the parser and make it trip over the next statement terminator, thus returning non-split statements. 💀

this should not be a problem though, as the original (invalid) SQL code would have been unusable anyway. remember that this is NOT a validating parser! she's a splitter, not a proofreader. 🫶

👀 SEE ALSO 👀

  • SQL::SplitStatement (perldoc SQL::SplitStatement)

Copyright 2011 Emanuele Zeppieri <emazep@cpan.org>.

⚖️ LICENSE ⚖️

this program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See <http://www.perl.com/perl/misc/Artistic.html>

💀 NO WARRANTY 💀

this program comes with NO WARRANTIES of any kind. it not only may cause loss of data and hardware damaging, but it may also cause several bad diseases to nearby people, including, but not limited to, diarrhoea, gonorrhea and dysmenorrhea. don't say you haven't been warned. 😭

🎀 and that's the whole page, bestie! this version came from perl v5.36.0, dated 2022-10-16, under the SQL-SPLIT(1p) banner. go split something responsibly 💖✨🦋
📦 where this page comes from