api.xml

<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node name="/db">
    <interface name="vx.db">
        <method name="ExecNoResult">
            <arg name="query" type="s" direction="in"/>
        </method>

        <method name="ExecScalar">
            <arg name="query" type="s" direction="in"/>
            <arg name="result" type="v" direction="out"/>
        </method>

        <method name="ExecRecordset">
            <arg name="query" type="s" direction="in"/>
            <arg name="colinfo" type="a(issnny)" direction="out"/>
            <!-- Returned data is:
                int32 column size
                string column name
                string column type
                int16 numeric precision
                int16 numeric scale
                uint8 nullability
                    - a bitfield, with only one bit currently defined,
                      0x1 = is nullable
            -->
            <arg name="data" type="v" direction="out"/>
            <!-- row-major order; the variant's signature is an array type
                 of the form a(...) where ... are the columns -->
            <arg name="nullity" type="aay" direction="out"/>
            <!-- 0 for not null, 1 for null -->
        </method>
        <method name="ExecChunkRecordset">
            <arg name="query" type="s" direction="in"/>
	    <!-- Returns signals of the same type as responses to
	    	ExecRecordset above, except also suffixed with:
		uint32 serial number of ExecChunkRecordset request

		Signals are called "ChunkRecordsetSig".  See below.

		The final bit of data (< 1 MB trailing) will be sent
		via the response to this message.  After the response,
		you know there's no more data coming.
	    -->
            <arg name="colinfo" type="a(issnny)" direction="out"/>
            <!-- Returned data is:
                int32 column size
                string column name
                string column type
                int16 numeric precision
                int16 numeric scale
                uint8 nullability
                    - a bitfield, with only one bit currently defined,
                      0x1 = is nullable
            -->
            <arg name="data" type="v" direction="out"/>
            <!-- row-major order; the variant's signature is an array type
                 of the form a(...) where ... are the columns -->
            <arg name="nullity" type="aay" direction="out"/>
            <!-- 0 for not null, 1 for null -->
	</method>
	<signal name="ChunkRecordsetSig">
	    <arg name="colinfo" type="a(issnny)"/>
            <!-- Returned data is:
                int32 column size
                string column name
                string column type
                int16 numeric precision
                int16 numeric scale
                uint8 nullability
                    - a bitfield, with only one bit currently defined,
                      0x1 = is nullable
            -->
            <arg name="data" type="v"/>
            <!-- row-major order; the variant's signature is an array type
                 of the form a(...) where ... are the columns -->
            <arg name="nullity" type="aay"/>
            <!-- 0 for not null, 1 for null -->
	    <arg name="reply_serial" type="u"/>
	    <!-- serial # of query this is in response to -->
	</signal>
        <method name="Test">
            <arg name="colinfo" type="a(issnny)" direction="out"/>
            <arg name="data" type="v" direction="out"/>
            <arg name="nullity" type="aay" direction="out"/>
	</method>

	<method name="CancelQuery">
            <arg name="kill_msg_id" type="u" direction="in"/>
            <arg name="pointless_return" type="s" direction="out"/>
	    <!-- just returns "Cancel" so that you're happy -->
	</method>

        <!-- Any of these can throw:
             vx.db.sqlerror - SQL statement error (text
                     parameter will include actual error)
             vx.db.toomuchdata - Scalar or Recordset result
                     is too large to transmit in a single d-bus message. Will
                     need to use a different API (not yet defined). text
                     parameter will indicate what the problem is
             vx.db.badschema - Schema returned by the query
                     contains features not supported (such as sql_variant).
                     text parameter will indicate what the problem is
             vx.db.exception - Method threw an exception
                     other than those listed above. Text parameter will contain
                     the normal .NET exception description and backtrace
        -->

        <!-- Future:
             - Transaction support
             - Execute particular procedures, not just SQL
        -->
    </interface>
</node>