alf-shell 0.14.0 → 0.15.0

data/doc/commands/exec.md

@@ -1,16 +0,0 @@
-
-Executes an .alf file on current database
-
-SYNOPSIS
-
-    alf #(command_name) [FILE]
-
-OPTIONS
-
-    #(summarized_options)
-
-DESCRIPTION
-
-This command executes the .alf file passed as first argument (or what comes
-on standard input) as a alf query to be executed on the current database.
-

data/doc/commands/help.md

@@ -1,11 +0,0 @@
-
-Show help about a specific command
-
-SYNOPSIS
-
-    alf #(command_name) COMMAND
-
-OPTIONS
-
-    #(summarized_options)
-

data/doc/commands/main.md

@@ -1,33 +0,0 @@
-
-alf - Relational algebra at your fingertips
-
-SYNOPSIS
-
-    alf [--version] [--help]
-    alf -e '(lispy command)'
-    alf [FILE.alf]
-    alf [alf opts] OPERATOR [operator opts] ARGS ...
-    alf help OPERATOR
-
-OPTIONS
-
-    #(summarized_options)
-
-RELATIONAL OPERATORS
-
-    #(summarized_subcommands relational_operators)
-
-EXPERIMENTAL RELATIONAL OPERATORS
-
-    #(summarized_subcommands experimental_operators)
-
-NON-RELATIONAL OPERATORS
-
-    #(summarized_subcommands non_relational_operators)
-
-OTHER NON-RELATIONAL COMMANDS
-
-    #(summarized_subcommands other_non_relational_commands)
-
-See 'alf help COMMAND' for details about a specific command.
-

data/doc/commands/show.md

@@ -1,12 +0,0 @@
-
-Output input tuples through the default renderer in a specific order.
-
-SYNOPSIS
-
-    alf #(command_name) NAME -- [ORDERING]
-
-DESCRIPTION
-
-When a name is specified as commandline arg, request the database to
-provide the corresponding relation variable and prints its value.
-Otherwise, take what comes on standard input.

data/doc/operators/non_relational/autonum.md

@@ -1,23 +0,0 @@
-
-Extend its operand with an unique autonumber attribute
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This non-relational operator guarantees uniqueness of output tuples by adding 
-an attribute called AS whose value is an auto-numbered Integer. 
-
-If the presence of duplicates was the only "non-relational" aspect of the input, 
-the result is a valid relation for which AS is a candidate key.
-
-EXAMPLE
-
-    # Autonumber suppliers with default attribute name
-    !(alf autonum suppliers)
-
-    # Autonumber suppliers with a `unique_id` attribute
-    !(alf autonum suppliers -- unique_id)
-

data/doc/operators/non_relational/clip.md

@@ -1,31 +0,0 @@
-
-Clip input tuples to a subset of attributes
-
-SYNOPSIS
-
-    #(signature)
-
-OPTIONS
-
-    #(summarized_options)
-
-DESCRIPTION
-
-This operator clips tuples on attributes whose names are specified in 
-ATTRIBUTES. This is similar to the relational PROJECT operator, expect 
-that CLIP does not remove duplicates afterwards.
-
-Clipping may therefore lead to bags of tuples instead of sets. The result
-is therefore **not** a valid relation unless a candidate key is preserved.
-
-With the allbut option, the operator keeps attributes in ATTRIBUTES, instead 
-of projecting them away. 
-
-EXAMPLE
-
-    # Clip suppliers on `name` and `city`
-    !(alf clip suppliers -- name city)
-
-    # Clip suppliers on all other attributes
-    !(alf clip suppliers --allbut -- name city)
-

data/doc/operators/non_relational/coerce.md

@@ -1,15 +0,0 @@
-
-Force attribute coercion according to a heading
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This operator coerces attributes of the input tuples according to HEADING.
-
-EXAMPLE
-
-  alf coerce parts -- weight Float color Color
-

data/doc/operators/non_relational/compact.md

@@ -1,20 +0,0 @@
-
-Remove tuple duplicates
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This non-relational operator removes duplicates from its input operand.
-In other words, it converts a bag of tuples to a set of tuples in a 
-brute-force manner.
-
-If the presence of duplicates was the only "non-relational" aspect of 
-the operand, the result is a valid relation.
-
-EXAMPLE
-
-  alf compact suppliers
-

data/doc/operators/non_relational/defaults.md

@@ -1,32 +0,0 @@
-
-Force default values on missing/nil attributes
-
-SYNOPSIS
-
-    #(signature)
-
-OPTIONS
-
-    #(summarized_options)
-
-DESCRIPTION
-
-This non-relational operator rewrites input tuples to ensure that all values 
-for attribute names specified in DEFAULTS are present and not nil. Missing or 
-nil attributes are replaced by the specified default value.
-
-A value specified in DEFAULTS may be any tuple expression. This allows computing 
-the default value as an expression on the current tuple.
-
-With the strict option, the operator projects resulting tuples on attributes for 
-which a default value has been specified. Using the strict mode guarantees that 
-the heading of all tuples is the same, and that no nil value ever remains. 
-
-Note that this operator never removes duplicates. Even in strict mode the result 
-might be an invalid relation. 
-
-EXAMPLE
-
-  alf defaults suppliers -- country "'Belgium'"
-  alf defaults --strict suppliers -- country "'Belgium'"
-

data/doc/operators/non_relational/generator.md

@@ -1,20 +0,0 @@
-
-Generate a relation with an auto-numbered attribute
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This non-relational operator generates a relation of one attribute called AS, 
-whose value is an auto-number ranging from 1 to SIZE, inclusively.
-
-EXAMPLE
-
-    # Default behavior: AS is `num` and SIZE is 10
-    !(alf generator)
-
-    # That you can override
-    !(alf generator -- 5 -- id)
-

data/doc/operators/non_relational/sort.md

@@ -1,24 +0,0 @@
-
-Sort input tuples according to an order relation
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This non-relational operator sorts input tuples according to ORDERING. 
-
-This is, of course, a non relational operator as relations are unordered 
-sets. It is provided for displaying purposes and normalization of 
-non-relational inputs.
-
-EXAMPLE
-
-  # Sort suppliers by name
-  !(alf sort suppliers -- name asc)
-
-  # Sort suppliers by city in descending order, then on name on ascending 
-  # order
-  !(alf sort suppliers -- city desc name asc)
-

data/doc/operators/non_relational/type-safe.md

@@ -1,20 +0,0 @@
-
-Check that input tuples are of a specified heading
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This non-relational ensures that input tuples match a given heading (in strict mode),
-or a projection (in non-strict mode). This is useful when connecting to data-sources whose
-relation representations must absolutely be checked for type safety.
-
-EXAMPLE
-
-  # Check that the suppliers have the correct heading (since is missing, but ok)
-  !(alf type-safe suppliers -- sid String name String status Integer city String since Date)
-
-  # Strict, no attribute can be missing
-  !(alf type-safe --strict suppliers -- sid String name String status Integer city String)

data/doc/operators/relational/extend.md

@@ -1,18 +0,0 @@
-
-Relational extension (additional, computed attributes)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This operator extends its operand with new attributes whose value is the result 
-of evaluating tuple expressions specified in EXT. The latter are specified as 
-(name, expression) pairs.
-
-EXAMPLE
-
-    # Compute a few attributes on suppliers by extension
-    !(alf extend supplies -- big "qty > 100"  price "qty * 12.2")
-

data/doc/operators/relational/frame.md

@@ -1,26 +0,0 @@
-
-Relational framing (aka offset/limit, yet sounder)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This command provides the classical offset/limit over the input relation.
-
-This operator skips tuples whose ranking according to `ordering` is between
-`0` and `offset` exclusive (in other words, it skips `offset` tuples). In
-addition, it returns maximum `limit` tuples.
-
-To be sound, this operator requires the ordering to include a candidate key
-for the input relation. Alf will automatically extend the ordering you provide
-to guarantee this, provided key inference is possible.
-
-EXAMPLE
-
-    # Take the first two suppliers ordered by name (then by id)
-    !(alf frame suppliers -- name -- 0 -- 2)
-
-    # Take the next two suppliers
-    !(alf frame suppliers -- name -- 2 -- 2)

data/doc/operators/relational/group.md

@@ -1,27 +0,0 @@
-
-Relational grouping (relation-valued attributes)
-
-SYNOPSIS
-
-    #(signature)
-
-OPTIONS
-
-    #(summarized_options)
-
-DESCRIPTION
-
-This operator groups attributes in ATTRIBUTES as a new, relation-valued 
-attribute named AS.
-
-With the allbut option, it groups all attributes not specified in ATTRIBUTES
-instead.
-
-EXAMPLE
-
-    # Group pid and qty as a relation-valued attribute names supplying
-    !(alf group supplies -- pid qty -- supplying)
-
-    # Group all but pid ...
-    !(alf group supplies --allbut -- pid -- supplying)
-

data/doc/operators/relational/hierarchize.md

@@ -1,14 +0,0 @@
-
-Relational hierarchy (recursive relation-trees)
-
-SYNOPSIS
-
-    #(signature)
-
-OPTIONS
-
-    #(summarized_options)
-
-DESCRIPTION
-
-This operator converts a "flat" relation to a recursively defined one.

data/doc/operators/relational/infer-heading.md

@@ -1,20 +0,0 @@
-
-Relational heading inference (print the relation type)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This operator simply outputs a relation containing one tuple: the heading of 
-its operand. 
-
-EXAMPLE
-
-    # What is the heading of the `suppliers` relation?
-    !(alf infer-heading suppliers)
-
-    # What is the heading of the following join?
-    !(alf join suppliers supplies | alf infer-heading)
-

data/doc/operators/relational/intersect.md

@@ -1,13 +0,0 @@
-
-Relational intersection (aka a logical and)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This operator computes the relational intersection of its operands. Such
-intersection is simply the set of tuples that appear both in LEFT and in 
-RIGHT.
-

data/doc/operators/relational/join.md

@@ -1,28 +0,0 @@
-
-Relational join (and cartesian product)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This operator computes the (natural) join of its operands. 
-
-Natural join means that, unlike what is commonly used in SQL, joining is based 
-on equality of all attributes that are shared between LEFT and RIGHT performed 
-on common attribute names. You can use the `rename` operator if this  behavior 
-does not fit your needs.
-
-When operands have no attribute in common, this operator naturally "degenerates" 
-to a cartesian product.
-
-EXAMPLE
-
-    # Computes natural join of suppliers and supplies (on sid, the only 
-    # attribute they have in common)
-    !(alf join suppliers supplies)
-
-    # The following example demontrates the cartesian product with a generated 
-    # relation
-    !(alf generator -- 3 -- num | alf join cities)

data/doc/operators/relational/matching.md

@@ -1,24 +0,0 @@
-
-Relational matching (join + project back on left)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This operator restricts its LEFT operand to tuples for which there exists at 
-least one tuple in RIGHT that (naturally) joins. This is a shortcut operator 
-for the following longer expression:
-
-    (project (join xxx, yyy), [xxx's attributes])
-
-Or equivalently,
-
-    (join xxx, (project xxx, [common attributes]))
-
-EXAMPLE
-
-    # Which suppliers supply at least one part?
-    !(alf matching suppliers supplies)
-