Commits

Kirill Simonov committed fd96aca

Added index entries for addons and functions.

  • Participants
  • Parent commits 475a01f

Comments (0)

Files changed (5)

doc/admin/cloud.rst

 These instructions outline how to use HTSQL using a cloud
 provider where you have a limited application environment.
 
+
+.. index:: Heroku
+
 Installing at Heroku
 ====================
 

doc/admin/deploy.rst

 and may appear inadequate for production deployment.  In particular,
 it does not not provide any means for authentication and lacks SSL support.
 
+.. index:: Apache
+
 Integration with Apache
 -----------------------
 
     http://code.google.com/p/modwsgi/wiki/QuickConfigurationGuide
 
 
+.. index:: Security
+
 Security
 ========
 

doc/admin/usage.rst

 Usage
 =====
 
-``htsql-ctl``
--------------
+.. index:: htsql-ctl
+
+Invoking ``htsql-ctl``
+----------------------
 
 Installing HTSQL creates a command-line application ``htsql-ctl``::
 
 
     $ htsql-ctl help <routine>
 
+.. index:: connection URI
+
 Database Connection
 -------------------
 
 You can use option ``-p`` to prompt for a password if you do not want
 to specify the database password in a command line.
 
+.. index:: htsql-ctl shell
+
 Command-line Shell
 ------------------
 
 
     $ htsql-ctl help shell
 
+.. index:: htsql-ctl server
+
 HTTP Server
 -----------
 
     $ htsql-ctl help server
 
 
+.. index:: htsql-ctl extension
+
 Extension Mechanism
 ===================
 
 
 Every component except ``engine`` and ``database`` is optional.
 
+.. index:: engine.sqlite, engine.pgsql, engine.mysql, engine.oracle,
+           engine.mssql
+
 ``engine.*``
 ------------
 
 * Oracle 10g+ (``engine.oracle``)
 * Microsoft SQL Server 2005+ (``engine.mssql``)
 
+.. index:: tweak.autolimit
+
 ``tweak.autolimit``
 -------------------
 
     tweak.autolimit:
       limit: 1000
 
+.. index:: tweak.cors
+
 ``tweak.cors``
 --------------
 
 
 .. _CORS: http://www.w3.org/TR/cors/
 
+.. index:: tweak.django, Django
+
 ``tweak.django``
 ----------------
 
 
 .. _Django: https://www.djangoproject.com/
 
+.. index:: tweak.meta
+
 ``tweak.meta``
 --------------
 
 
 .. htsql:: /meta(/meta(/table))
 
+.. index:: tweak.override
+
 ``tweak.override``
 ------------------
 
         num_school: (count(@school))
         trunc_month($d): (date(year($d), month($d), 1))
 
+.. index:: tweak.resource
 
 ``tweak.resource``
 ------------------
     HTTP root for static files, excluding leading and trailing ``/``
     (default: ``-``)
 
+.. index:: tweak.shell
 
 ``tweak.shell``
 ---------------
 
 .. _CodeMirror: http://codemirror.net/
 
+.. index:: tweak.sqlalchemy, SQLAlchemy
+
 ``tweak.sqlalchemy``
 --------------------
 
 
 .. _SQLAlchemy: http://www.sqlalchemy.org/
 
+.. index:: tweak.timeout
+
 ``tweak.timeout``
 -----------------
 

doc/ref/functions.rst

 .. |switch-1-in| replace:: ``switch(1,1,'up',0,'down')``
 .. |switch-0-in| replace:: ``switch(0,1,'up',0,'down')``
 
+.. index:: boolean()
+
 Boolean Cast
 ------------
 
 .. htsql:: /{boolean(integer(null())), boolean(0.0),
              boolean(date('2010-04-15'))}
 
+.. index:: true(), false()
+
 Logical Values
 --------------
 
 
 .. htsql:: /{true(), false()}
 
+.. index:: |, &, !
+
 Logical Operators
 -----------------
 
 .. htsql:: /school?exists(program)&exists(department)|!campus
    :cut: 3
 
+.. index:: null(), is_null(), if_null(), null_if()
+
 NULL Checking
 -------------
 
 
 .. htsql:: /course{title, credits}?!(credits :null_if 0)
 
+.. index:: =, !=, ==, !==
+
 Equality Operators
 ------------------
 
 .. htsql:: /school{code, campus=='old', campus=='north', campus=='south'}
    :cut: 3
 
+.. index:: <, <=, >, >=
+
 Comparison Operators
 --------------------
 
 .. htsql:: /school?count(department)>=4
    :cut: 3
 
+.. index:: if(), switch()
+
 Branching Functions
 -------------------
 
 .. |decimal-from-string-in| replace:: ``decimal(string('17.25'))``
 .. |float-from-string-in| replace:: ``float(string('223607e-5'))``
 
+.. index:: integer(), decimal(), float()
+
 Numeric Cast
 ------------
 
 
 .. htsql:: /{integer(2.125), decimal('271828e-5'), float(string(60))}
 
+.. index:: +, -, *, /
+
+.. **
+
 Arithmetic Expressions
 ----------------------
 
 
 .. htsql:: /{(2+4)*7, -(98-140), 21/5}
 
+.. index:: round(), trunc()
+
 Rounding Functions
 ------------------
 
 .. |slice-end-in| replace:: ``slice('HTSQL',2,null())``
 .. |replace-in| replace:: ``replace('HTSQL','SQL','RAF')``
 
+.. index:: string()
+
 String Cast
 -----------
 
                +string(count(course))+' courses' :as text}
               ?exists(course)
 
+.. index:: length()
+
 String Length
 -------------
 
 
 .. htsql:: /{length('HTSQL'), length(''), length(null())}
 
+.. index:: +
+
 Concatenation
 -------------
 
 .. htsql:: /course{department_code+'.'+string(no) :as code, title}
    :cut: 3
 
+.. index:: ~, !~
+
 Substring Search
 ----------------
 
 
 .. htsql:: /school?code~'art'
 
+.. index:: head(), tail(), slice(), at()
+
 Substring Extraction
 --------------------
 
 
 .. htsql:: /{'HTSQL' :at(2), 'HTSQL' :at(1,3), 'HTSQL': at(-1,-3)}
 
+.. index:: upper(), lower()
+
 Case Conversion
 ---------------
 
 
 .. htsql:: /{'htsql' :upper, 'HTSQL' :lower}
 
+.. index:: trim(), ltrim(), rtrim()
+
 String Trimming
 ---------------
 
      '  HTSQL  ' :ltrim :replace(' ','!'),
      '  HTSQL  ' :rtrim :replace(' ','!')}
 
+.. index:: replace()
+
 Search and Replace
 ------------------
 
 .. |date-dec-in| replace:: ``date('2028-12-09')-6813``
 .. |date-diff-in| replace:: ``date('2028-12-09') - date('1991-08-20')``
 
+.. index:: date(), time(), datetime()
+
 Date/Time Cast
 --------------
 
 .. htsql:: /student?dob<date('1982-06-01')
    :cut: 3
 
+.. index:: date(), datetime()
+
 Date/Time Construction
 ----------------------
 
 
 .. htsql:: /{date(2010,4,15), date(2010,3,46), date(2011,-8,15)}
 
+.. index:: date(), time(), year(), month(), day(), hour(), minute(),
+           second()
+
 Component Extraction
 --------------------
 
             $t := time('20:13'),
             $dt := datetime($d,$t))
 
+.. index:: +, -
+
 Date/Time Arithmetics
 ---------------------
 
 produces a flow of values, and generates a single *aggregating* value
 from it.
 
+.. index:: exists(), every(), count()
+
 Boolean Aggregates
 ------------------
 
      count(pia_course.credits>=5)}
     :where pia_course := course?department.code='pia'
 
+.. index:: min(), max()
+
 Extrema
 -------
 
    /{min(pia_course.credits), max(pia_course.credits)}
     :where pia_course := course?department.code='pia'
 
+.. index:: sum(), avg()
+
 Sum and Average
 ---------------
 
 .. |select-out| replace:: ``school.select(code,name)``
 .. |link-in| replace:: ``school.(campus -> school)``
 
+.. index:: ?, filter()
+
 Sieving
 -------
 
 
 .. htsql:: /school.filter(campus='south')
 
+.. index:: ^, distinct()
+
 Projection
 ----------
 
 
 .. **
 
+.. index:: {}, select()
+
 Selection
 ---------
 
 .. |define-in| replace:: ``define(num_prog:=count(program))``
 .. |where-in| replace:: ``count(course?credits>$c) :where $c:=avg(course.credits)``
 
+.. index:: define(), where()
+
 Calculated Attributes
 ---------------------
 
 These functions add calculated attributes and references to the current
 scope.
 
+.. index:: @, root(), this()
+
 Scopes
 ------
 
 
 .. |as-in| replace:: ``count(program) :as '# of programs'``
 
+.. index:: as()
+
 Title
 -----
 
 .. htsql:: /school{code :as ID, count(program) :as '# of Programs'}
    :cut: 3
 
+.. index:: +, -
+
 Direction Decorators
 --------------------
 
    :cut: 3
 
 
+.. index:: html(), txt(), csv(), tsv(), json()
+
 Formatters
 ==========
 

doc/ref/types.rst

 operands, the integer operand is converted to decimal.
 
 
+.. index:: boolean
+
 Boolean Type
 ============
 
 .. |oracle-native-bool| replace:: ``NUMBER(1) CHECK (_ IN (0, 1))``
 
 
+.. index:: integer, decimal, float
+
 Numeric Types
 =============
 
 +----------------------+---------------------------+
 
 
+.. index:: string
+
 String Type
 ===========
 
 +----------------------+---------------------------+
 
 
+.. index:: enum
+
 Enum Type
 =========
 
 Note: only PostgreSQL and MySQL support `enum` data type.
 
 
+
+.. index:: date, time, datetime
+
 Date/Time Types
 ===============