# doc-cache created by Octave 10.3.0
# name: cache
# type: cell
# rows: 3
# columns: 5
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
dbrowfilter


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 820
 -- ROWFILT = dbrowfilter(C)
 -- ROWFILT = dbrowfilter(T)
     Create an unconstrained dbrowfilter object with columns names.

     Inputs
     ......

     C
          A column name, cell array of column names.
     T
          A table to use for column names.

     Outputs
     .......

     ROWFILT
          a dbrowfilter object

     Object Properties
     .................

     Object properties are the names of the columns on creation of the
     filter.

     Constraints can be set on a specific field of the filter by setting
     a comparison value for the variable name.

     Examples
     ........


          # create a dbrowfilter with 2 columns
          rf = dbrowfilter({'Column1', 'Column2'});
          # add a constraint for Column1 > 10
          rfc = rf.Column1 > 10

     See also: dbtable.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 62
Create an unconstrained dbrowfilter object with columns names.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
dbtable


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1978
 -- TABLE = dbtable()
 -- TABLE = dbtable (VAR1, ... VARN)
 -- TABLE = dbtable (... PROPERTYNAME, PROPERTYVALUE)
     Create a table of data

     dbtable is a basic implementation of a table type to avoid
     dependencies on other packages.

     Inputs
     ......

     VAR1 ... VARN
          Variables or data to be used as the column data of the table.
          When the input is a variable, the variable name will be used
          as the column name, otherwise the columns will be Var1 ...
          VarN.
     PROPERTYNAME, PROPERTYVALUE
          Property name/value pairs, where known property names are:
          VariableNames
               A cell string matching the number of input columns with
               the name to use for the
          DimensionNames
               A cell string matching of length 2 for using as dimension
               access.  If not specified it will be "Rows" and
               "Variables".

     Outputs
     .......

     TABLE
          a dbtable object

     Object Properties
     .................

     A dbtable object has the following properties:
     Properties
          A table properties struct.

          The table struct includes fields:
          Description
               Text table description
          DimensionNames
               Cell array of Row and Variable dimension names
          VariableNames
               Cell array of variable (column) names
          UserData
               User data value

     Examples
     ........

     Directly create a 2 column table from input of each column

          t = dbtable([0;1;3], [2;4;6]);

     Directly create a 2 column table from input of each column, and
     specify variable names

          t = dbtable([0;1;3], [2;4;6], "VariableNames", {'Variable1', 'Variable2'});

     Create a 2 column table from 2 variables V1, V2

          V1 = [0;1;3];
          V2 = [2;4;6];
          t = dbtable(V1, V2);

     See also: readdbtable, struct2dbtable.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 22
Create a table of data



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
readdbtable


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 336
 -- T = readdbtable (FILENAME)
     Create a dbtable from a file

     Currently, this is using a very simplistic approach to read data
     from a CSV formatted file only.

     Inputs
     ......

     FILENAME
          Filename for file containing tabular data

     Outputs
     .......

     T
          a dbtable of the read data


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 28
Create a dbtable from a file



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 6
sqlite


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1134
 -- DB = sqlite (FILENAME)
 -- DB = sqlite (FILENAME, MODE)
     Create a sqlite database connection

     Inputs
     ......

     ‘FILENAME’
          Filename of the sqlite database
     ‘MODE’
          mode for the sqlite access 'readonly', 'connect' (default),
          'create'.

     Outputs
     .......

     ‘DB’
          a opened SQLITE database as a octave_sqlite object

     Object Properties
     .................

     The octave_sqlite object has the following properties:

     Database
          The name of the opened database file (readonly)
     IsOpen
          Boolean field for if the database is currently open (readonly)
     IsReadOnly
          Boolean field for if the database was opened in readonly mode.
          (readonly)
     AutoCommit
          String flag field for whether database is in auto commit mode.
          "on" (default) or "off".

     Examples
     ........

     Open a sqlite database, failing if it does not exist.

          db = sqlite("mytest.db");

     Open a sqlite database, creating it if it does not exist.

          db = sqlite("mytest.db", "create");


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 35
Create a sqlite database connection



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 14
struct2dbtable


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 555
 -- T = struct2dbtable (ASTRUCT)
     Create a dbtable from a struct

     This function uses the field names and data of the fields to create
     a table representation of the struct.

     Each fieldname will be a variable in the table.  The data for each
     variable will be the data of the fieldname, and is expected to be a
     uniform size for all fields in the struct.

     Inputs
     ......

     ASTRUCT
          A struct with same number of elements in each field

     Outputs
     .......

     T
          a dbtable of the ASTRUCT data


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 30
Create a dbtable from a struct





