Crate sql_minifier

This crate provides bindings for the Sirius executable. All the parameters of sirius should be accessible from this crate.

SQL minifier

This crate provides a simple SQL minifier. It removes comments, unnecessary whitespaces, and shortens they keywords that can be shortened from SQL files.

Installation

Add the following to your Cargo.toml file:

[dependencies]
sql_minifier = "0.1.2"

or use the following command:

cargo add sql_minifier

Usage

The create provides two main functions:

• minifiy_sql_to_string which reads an SQL file and returns a String of the minified SQL.
• minifiy_sql_to_file which reads an SQL file and writes the minified SQL to a new file specified by the user.

Additionally, the crate provides a macro minify_sql_files! that can be used to minify SQL files at compile time. The macro accepts file paths as input.

It’s important to note that the macro will write the minified SQL to a new file with the same name as the input file, but with the suffix _minified. Additionally, it will append the _minified suffix just before the last . in the file name. For instance, if the input file is test_data/test_file_1.sql, the minified file will be named test_data/test_file_1_minified.sql.

The macro can be utilized as follows:

use sql_minifier::prelude::*;
minify_sql_files!(
  "test_data/test_file_1.sql",
  "test_data/test_file_2.sql",
  "test_data/test_file_3.sql"
  );

Example

The following SQL file:

-- Your SQL goes here
CREATE TABLE IF NOT EXISTS taxa (
    -- The unique identifier for the taxon
    id UUID PRIMARY KEY,
    -- The scientific name of the taxon
    name TEXT NOT NULL,
    -- The NCBI Taxon ID is a unique identifier for a taxon in the NCBI Taxonomy database
    -- which may be NULL when this taxon is not present in the NCBI Taxonomy database.
    ncbi_taxon_id INTEGER
);

will be minified to:

CREATE TABLE IF NOT EXISTS taxa ( id UUID PRIMARY KEY, name TEXT NOT NULL, ncbi_taxon_id INT);

A more complex SQL file:

-- SQL defining the container_horizontal_rules table.
-- The container horizontal rules define whether an item type can be placed next to another item type.
-- For instance a acid product cannot be placed next to a base product. Generally speaking, most items
-- can be placed next to each other, but some items cannot be placed next to each other. These rules
-- are defined in the form of a deny-list, meaning that if a rule is not defined, then the item type
-- can be placed next to any other item type. The rules are defined by an admin user, and are used to
-- enforce the placement rules when creating or updating items. Some items may only be placed next to
-- items that are within a certain temperature, humidity, or pressure range. These constraints are also
-- defined in the container rules.
CREATE TABLE container_horizontal_rules (
    id UUID PRIMARY KEY REFERENCES describables(id) ON DELETE CASCADE,
    item_type_id UUID REFERENCES item_categories(id) ON
    DELETE
        CASCADE,
        other_item_type_id UUID REFERENCES item_categories(id) ON
    DELETE
        CASCADE,
        minimum_temperature FLOAT DEFAULT NULL,
        maximum_temperature FLOAT DEFAULT NULL,
        minimum_humidity FLOAT DEFAULT NULL,
        maximum_humidity FLOAT DEFAULT NULL,
        minimum_pressure FLOAT DEFAULT NULL,
        maximum_pressure FLOAT DEFAULT NULL,
        CHECK (
            minimum_temperature IS NULL
            OR maximum_temperature IS NULL
            OR minimum_temperature <= maximum_temperature
        ),
        /* The minimum humidity must be less than or
        equal to the maximum humidity. */
        CHECK (
            minimum_humidity IS NULL
            OR maximum_humidity IS NULL
            OR minimum_humidity <= maximum_humidity
        ),
        CHECK (
            minimum_pressure IS NULL
            OR maximum_pressure IS NULL
            OR minimum_pressure <= maximum_pressure
        )
);
/* and other multiline comment */

will be minified to:

CREATE TABLE container_horizontal_rules ( id UUID PRIMARY KEY REFERENCES describables(id) ON DELETE CASCADE, item_type_id UUID REFERENCES item_categories(id) ON DELETE CASCADE, other_item_type_id UUID REFERENCES item_categories(id) ON DELETE CASCADE, minimum_temperature FLOAT DEFAULT NULL, maximum_temperature FLOAT DEFAULT NULL, minimum_humidity FLOAT DEFAULT NULL, maximum_humidity FLOAT DEFAULT NULL, minimum_pressure FLOAT DEFAULT NULL, maximum_pressure FLOAT DEFAULT NULL, CHECK ( minimum_temperature IS NULL OR maximum_temperature IS NULL OR minimum_temperature <= maximum_temperature ), CHECK ( minimum_humidity IS NULL OR maximum_humidity IS NULL OR minimum_humidity <= maximum_humidity ), CHECK ( minimum_pressure IS NULL OR maximum_pressure IS NULL OR minimum_pressure <= maximum_pressure ));

Modules

• prelude
  Prelude module

Macros

• minify_sql_files
  This macro will minify all the SQL files passed as arguments and save them with the same name but with ‘_minified.sql’ appended to the original filename So if the file name is ‘file.sql’, the minified file will be ‘file_minified.sql’