api.xml

   1 <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
   2 <node name="/db">
   3     <interface name="vx.db">
   4         <method name="ExecNoResult">
   5             <arg name="query" type="s" direction="in"/>
   6         </method>
   7
   8         <method name="ExecScalar">
   9             <arg name="query" type="s" direction="in"/>
  10             <arg name="result" type="v" direction="out"/>
  11         </method>
  12
  13         <method name="ExecRecordset">
  14             <arg name="query" type="s" direction="in"/>
  15             <arg name="colinfo" type="a(issnny)" direction="out"/>
  16             <!-- Returned data is:
  17                 int32 column size
  18                 string column name
  19                 string column type
  20                 int16 numeric precision
  21                 int16 numeric scale
  22                 uint8 nullability
  23                     - a bitfield, with only one bit currently defined,
  24                       0x1 = is nullable
  25             -->
  26             <arg name="data" type="v" direction="out"/>
  27             <!-- row-major order; the variant's signature is an array type
  28                  of the form a(...) where ... are the columns -->
  29             <arg name="nullity" type="aay" direction="out"/>
  30             <!-- 0 for not null, 1 for null -->
  31         </method>
  32
  33         <!-- Any of these can throw:
  34              vx.db.sqlerror - SQL statement error (text
  35                      parameter will include actual error)
  36              vx.db.toomuchdata - Scalar or Recordset result
  37                      is too large to transmit in a single d-bus message. Will
  38                      need to use a different API (not yet defined). text
  39                      parameter will indicate what the problem is
  40              vx.db.badschema - Schema returned by the query
  41                      contains features not supported (such as sql_variant).
  42                      text parameter will indicate what the problem is
  43              vx.db.exception - Method threw an exception
  44                      other than those listed above. Text parameter will contain
  45                      the normal .NET exception description and backtrace
  46         -->
  47
  48         <!-- Future:
  49              - Transaction support
  50              - Execute particular procedures, not just SQL
  51              - Ability to stream results as signals rather than in a single
  52                message (allows interleaving results and larger sized result
  53                sets)
  54         -->
  55     </interface>
  56 </node>