출처:https://developer.palm.com/content/api/reference/data-types/db8.html

db8 Data Types

BatchOperation

Method and params for batch operation.

Schema

{
   "method" : string,
   "params" : any
}

Elements

BatchResponse

Response to batch operation.

Schema

{
   "returnValue" : boolean,
   "responses"   : any array
}

Elements

CountResponse

Number of objects affected by operation.

Schema

{
   "returnValue" : boolean,
   "count"       : int
}

Elements

ErrResponse

Standard error response, containing operation success or failure flag, error code and error message.

Schema

{
   "returnValue" : boolean,
   "errorCode"   : int,
   "errorText"   : string
}

Elements

FindResponse

Response to a find objects operation.

Schema

{
   "returnValue" : boolean,
   "results"     : any,
   "count"       : int,
   "next"        : string
}

Elements

GetResponse

Parameters for get objects operation response.

Schema

{
      "returnValue" : boolean,
      "results"     : any
}

Elements

IndexClause

Used in the putKind call for creating kind object indexes. Note that indexes determine the type of queries your app can make. See Queries and Indexing for more information.

Set the "incDel" flag to true if you want future queries to return marked as deleted objects. Objects are not completely deleted until an administrative purge operation takes place.

Schema

{
   "name"    : string,
   "props"   : IndexPropClause,
   "incDel"  : boolean
}

Elements

Example

{
   "name"   : "state", 
   "props"  : [{"name": "state"}],
   "incDel" : false
}

IndexPropClause

Defines index property for IndexClause

Schema

{
   "name"     : string,
   "collate"  : string, 
   "default"  : any,
   "tokenize" : string,
   "type"     : string
}

Elements

NotificationResponse

Notifies caller of change in query results returned from a "find" call.

Schema

{
   "returnValue" : boolean,
   "fired"       : boolean
}

Elements

PutResponse

Indicates success of operation and returns id and rev fields for each object.

Schema

{
   "returnValue" : boolean,
   "results"     : PutResult 
}

Elements

PutResult

Contains "id" and "rev" fields in PutResponse for JSON data object.

Schema

{
   "id"    : any,
   "rev"   : any
}

Elements

Query

Defines a db8 query.

Schema

{
   "select"  : string array,
   "from"    : string,
   "where"   : WhereClause array,
   "orderBy" : string,
   "desc"    : boolean,
   "incDel"  : boolean,
   "limit"   : int,
   "page"    : string
}

Elements

Example

{
   "select"  : ["displayName", "state"],
   "from"    : "com.mystuff.contacts:1",
   "where"   : [{"prop":"state","op":"=","val":"CA"}], 
   "orderBy" : "displayName",
   "desc"    : true 
}

ReserveIdsResponse

Contains operation success or failure flag and array of reserved db8 IDs returned from "reserveIds" call.

Schema

{
   "returnValue" : boolean,
   "ids"         : string array
}

Elements

RevSetClause

Defines a revision set—subset of an object's properties that your app can be notified about when one of the properties is modified. See Using Revision Sets for more information.

Schema

{
   "name"  : string,
   "props" : RevSetPropClause array
}

Elements

RevSetPropClause

A property in a RevSetClause.

Schema

{
   "name"  : string,
}

Elements

SuccessResponse

Indicates operation success or failure.

Schema

{
   "name"  : string,
}

Elements

Example

{
   "returnValue": false
}

WhereClause

Defines a SQL-like JSON where clause for a db8 Query.

Schema

{
   "prop"    : string,
   "op"      : string, 
   "val"     : any,
   "collate" : string
}

Elements

Example

{
   "prop" : "state",
   "op"   : "=",
   "val"  : "CA"
}