alf-shell 0.14.0 → 0.15.0

data/Gemfile

@@ -1,11 +1,14 @@
 source 'http://rubygems.org'
 
 group :runtime do
-  gem "alf-core", "~> 0.14.0"
-  gem "quickl", "~> 0.4.3"
+  gem "quickl",   "~> 0.4.3"
+
+  gem "alf-shell", path: "."
+  gem "alf-core",  path: "../alf-core"
 end
 
 group :development do
+  gem "alf-doc",   path: "../alf-doc"
   gem "rake", "~> 10.1"
   gem "rspec", "~> 2.14"
 end

data/Gemfile.lock

@@ -1,14 +1,31 @@
-GEM
-  remote: http://rubygems.org/
+PATH
+  remote: .
   specs:
-    alf-core (0.14.0)
+    alf-shell (0.15.0)
+      alf-core (~> 0.15.0)
+      quickl (~> 0.4.3)
+
+PATH
+  remote: ../alf-core
+  specs:
+    alf-core (0.15.0)
       domain (~> 1.0)
       myrrha (~> 3.0)
       path (~> 1.3)
-      sexpr (~> 0.5.1)
+      sexpr (~> 0.6.0)
+
+PATH
+  remote: ../alf-doc
+  specs:
+    alf-doc (0.15.0)
+      alf-core (~> 0.15.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
     diff-lcs (1.2.4)
     domain (1.0.0)
-    highline (1.6.19)
+    highline (1.6.20)
     myrrha (3.0.0)
       domain (~> 1.0)
     path (1.3.3)
@@ -18,17 +35,19 @@ GEM
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.4)
-    rspec-expectations (2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.3)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.1)
-    sexpr (0.5.1)
+    rspec-mocks (2.14.4)
+    sexpr (0.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  alf-core (~> 0.14.0)
+  alf-core!
+  alf-doc!
+  alf-shell!
   highline (~> 1.6)
   quickl (~> 0.4.3)
   rake (~> 10.1)

data/bin/alf

@@ -2,6 +2,8 @@
 module AlfLauncher
 
   def self.load
+    require "alf"
+  rescue LoadError
     require "alf-shell"
   end
   

data/doc/man/alf-explain.man

@@ -0,0 +1,22 @@
+.TH alf\-explain
+.PP
+Show the logical (optimizer) and physical (compiler) plans of a query.
+.SH Synopsis
+.PP
+\fB\fCalf\fR explain \fIQUERY\fP
+.SH Description
+.PP
+This command prints the logical and physical query plans for QUERY to
+standard output:
+.RS
+.IP \(bu 2
+The logical plan is post\-optimizer and allows checking that the latter
+performs correctly.
+.IP \(bu 2
+The physical plan provides information about compilation. In particular it
+provides feedback about the effective delegation to underlying database
+engines, as well as involved SQL queries.
+.RE
+.SH Example
+.PP
+\fB\fCalf\fR \fB\fC--examples\fR explain "restrict(suppliers, city: 'London')"

data/doc/man/alf-metadata.man

@@ -0,0 +1,13 @@
+.TH alf\-metadata
+.PP
+Show metadata about a query, such as heading and candidate keys.
+.SH Synopsis
+.PP
+\fB\fCalf\fR metadata \fIQUERY\fP
+.SH Description
+.PP
+This command prints some metadata (e.g. heading, keys, etc.) about the
+expression passed as first argument.
+.SH Example
+.PP
+\fB\fCalf\fR \fB\fC--examples\fR metadata "restrict(suppliers, city: 'London')"

data/doc/man/alf-show.man

@@ -0,0 +1,16 @@
+.TH alf\-show
+.PP
+Evaluates a query and shows the result.
+.SH Synopsis
+.PP
+\fB\fCalf\fR [\fB\fC--csv\fR|\fB\fC--json\fR\&...] show \fIQUERY\fP \-\- [\fIORDERING\fP]
+.SH Description
+.PP
+Take a query argument and execute it against the current database (according
+to options passed to the \fB\fCalf\fR main command). Show the result on standard
+output. The format (e.g. json) may be specified through \fB\fCalf\fR main options.
+.PP
+When an ordering is specified, tuples are rendered in the order specified.
+.SH Example
+.PP
+\fB\fCalf\fR \fB\fC--examples\fR show "restrict(suppliers, city: 'London')" \-\- name DESC

data/doc/man/alf.man

@@ -0,0 +1,77 @@
+.TH alf
+.PP
+Relational algebra at your fingertips
+.SH Synopsis
+.PP
+\fB\fCalf\fR [\fB\fC--version\fR] [\fB\fC--help\fR]
+.PP
+\fB\fCalf\fR \fIFILE.alf\fP
+.PP
+\fB\fCalf\fR show \fIQUERY\fP
+.PP
+\fB\fCalf\fR explain \fIQUERY\fP
+.PP
+\fB\fCalf\fR help \fIOPERATOR\fP
+.SH Options
+.TP
+\fB\fC--rash\fR
+    Render output as ruby hashes
+.TP
+\fB\fC--text\fR
+    Render output as a text table
+.TP
+\fB\fC--yaml\fR
+    Render output in YAML
+.TP
+\fB\fC--json\fR
+    Render output in JSON
+.TP
+\fB\fC--csv\fR
+    Render output in CSV
+.TP
+\fB\fC--examples\fR
+    Use the suppliers and parts example database
+.TP
+\fB\fC--db=DB\fR
+    Set the database (adapter) to use. Recognized values can be
+    folders with recognized files, or an URL to a SQL database
+    (e.g. postgres://user:pass@host/database)
+.TP
+\fB\fC--stdin=READER\fR
+    Specify the kind of reader when reading on standard input
+    (i.e. rash, csv, json, ruby, or yaml)
+.TP
+\fB\fC-Idirectory\fR
+    Specify $LOAD_PATH directory (may be used more than once)
+.TP
+\fB\fC-rlibrary\fR
+    Require the specified ruby library, before executing alf
+.TP
+\fB\fC--ff=FORMAT\fR
+    Specify the floating point format
+.TP
+\fB\fC--[no-]pretty\fR
+    Enable/disable pretty print best effort
+.TP
+\fB\fC-h\fR, \fB\fC--help\fR
+    Show this help
+.TP
+\fB\fC-v\fR, \fB\fC--version\fR
+    Show version and copyright
+.SH Commands
+.TP
+\fB\fChelp\fR
+    Shows help about a specific command, relational operator, aggregator,
+    or predicate.
+.TP
+\fB\fCshow\fR
+    Evaluates a query and shows the result in a specified format.
+.TP
+\fB\fCmetadata\fR
+    Show metadata for a query (heading, keys).
+.TP
+\fB\fCexplain\fR
+    Show the logical (optimizer) and physical (compiler) plans of a query.
+.PP
+See \fB\fCalf help COMMAND\fR for details about a specific command or \fB\fCalf help
+OPERATOR\fR for documentation of a relational operator.

data/doc/man/allbut.man

@@ -0,0 +1,39 @@
+.TH Allbut
+.PP
+Projects a subset of attributes away.
+.SH Signature
+.PP
+.RS
+.nf
+allbut(operand: Relation, attributes: AttrList) -> Relation
+.fi
+.RE
+.SH Examples
+.PP
+.RS
+.nf
+allbut(suppliers, [:city])
+.fi
+.RE
+.SH Description
+.PP
+Computes the relation obtained by removing a subset of attributes from
+\fB\fCoperand\fR tuples.
+.PP
+This operator is the inverse of \fB\fCproject\fR\&. While the latter \fIkeeps\fP
+attributes, this one \fIremoves\fP them. \fB\fCproject\fR actually supports an allbut
+variant, which is equivalent to this operator. In other words, this
+operator can be understood as follows:
+.PP
+.RS
+.nf
+def allbut(operand, attributes)
+  project(operand, attributes, allbut: true)
+end
+allbut(suppliers, [:city, :status])
+.fi
+.RE
+.SH Implementation notes
+.PP
+Unlike SQL, this operator ALWAYS remove duplicates. There is no way, in
+Alf, to compute \fIbags\fP of tuples.

data/doc/man/among.man

@@ -0,0 +1,25 @@
+.TH Among
+.PP
+Among a set of values
+.SH Signature
+.PP
+.RS
+.nf
+among(val: Alpha|AttrName, vals: Set<Alpha>) -> Predicate
+.fi
+.RE
+.SH Examples
+.PP
+.RS
+.nf
+among(:status, [10, 30])
+.fi
+.RE
+.SH Description
+.PP
+This predicates checks whether \fB\fCval\fR belongs to the set of values \fB\fCvals\fR\&.
+.SH Implementation notes
+.PP
+The set \fB\fCvals\fR may only contain pure values, attribute names are not
+supported. Any enumerable of such values is supported in practice, e.g.
+an Array literal.

data/doc/man/avg.man

@@ -0,0 +1,37 @@
+.TH Avg
+.PP
+Average
+.SH Signature
+.PP
+.RS
+.nf
+avg(expr: AttrName|(Tuple->Numeric)) -> Aggregator
+.fi
+.RE
+.SH Examples
+.PP
+.RS
+.nf
+avg(:qty)
+.fi
+.RE
+.PP
+.RS
+.nf
+avg{|t| t.qty * t.price }
+.fi
+.RE
+.PP
+.RS
+.nf
+avg(->(t){ t.qty * t.price })
+.fi
+.RE
+.SH Description
+.PP
+Aggregates through \fB\fCv1 + v2 + ... + vn / n\fR\&.
+.SH Implementation notes
+.PP
+This aggregate function should only be used with numeric types. As of
+current Alf version, it does not aggregate empty sets correctly on
+non\-numeric data types.

data/doc/man/between.man

@@ -0,0 +1,24 @@
+.TH Between
+.PP
+Between (inclusive)
+.SH Signature
+.PP
+.RS
+.nf
+between(val: Alpha|AttrName, min: Alpha|AttrName, max: Alpha|AttrName) -> Predicate
+.fi
+.RE
+.SH Examples
+.PP
+.RS
+.nf
+between(:status, 10, 30)
+.fi
+.RE
+.SH Description
+.PP
+This predicates checks whether a value (\fB\fCval\fR) is between two bounds \fB\fCmin\fR
+and \fB\fCmax\fR, inclusive on both sides.
+.SH Implementation notes
+.PP
+This predicate is equivalent to \fB\fCgte(_val_,_min_) & lte(_val_,_max_)\fR\&.

data/doc/man/concat.man

@@ -0,0 +1,55 @@
+.TH Concat
+.PP
+String concatenation
+.SH Signature
+.PP
+.RS
+.nf
+concat(expr: AttrName|(Tuple->Numeric)) -> Aggregator
+.fi
+.RE
+.SH Examples
+.PP
+.RS
+.nf
+concat(:name)
+.fi
+.RE
+.PP
+.RS
+.nf
+concat(:name, between: ', ')
+.fi
+.RE
+.PP
+.RS
+.nf
+concat(between: ', '){|t| t.name }
+.fi
+.RE
+.PP
+.RS
+.nf
+concat(->(t){ t.name.upcase }, between: ', ')
+.fi
+.RE
+.SH Description
+.PP
+Concatenates string representations of input values.
+.SH Implementation notes
+.PP
+This aggregate function can be applied to any data type, not only String
+attributes. Ruby's \fB\fCto_s\fR will be used on values prior to concatenation.
+.PP
+The options are:
+.RS
+.IP \(bu 2
+\fB\fCbefore\fR starts the resulting string (defaults to '')
+.IP \(bu 2
+\fB\fCafter\fR ends the resulting string (defaults to '')
+.IP \(bu 2
+\fB\fCbetween\fR is used between each value
+.RE
+.PP
+As of current Alf version, the order in which the values are concatenated
+is not guaranteed. So far, this function is thus non\-deterministic.

data/doc/man/contradiction.man

@@ -0,0 +1,26 @@
+.TH Contradiction
+.PP
+FALSE
+.SH Signature
+.PP
+.RS
+.nf
+contradiction() -> Predicate
+.fi
+.RE
+.SH Examples
+.PP
+.RS
+.nf
+false
+.fi
+.RE
+.PP
+.RS
+.nf
+contradiction
+.fi
+.RE
+.SH Description
+.PP
+This predicate always return false. It is equivalent to \fB\fC->(t){ false }\fR\&.

data/doc/man/count.man

@@ -0,0 +1,20 @@
+.TH Count
+.PP
+Count
+.SH Signature
+.PP
+.RS
+.nf
+count() -> Aggregator
+.fi
+.RE
+.SH Examples
+.PP
+.RS
+.nf
+count()
+.fi
+.RE
+.SH Description
+.PP
+Counts the number of input values.