# databaseQuery

Call this API at the server side. For more information, see Server API.

Queries records in database.

# Request Address

POST https://api.weixin.qq.com/tcb/databasequery?access_token=ACCESS_TOKEN

# Request Parameters

Attribute	Type	Required	Description
access_token	string	Yes	Credentials to call API
env	string	Yes	Cloud environment ID
query	string	Yes	Database operation statement

# Return Value

# Object

JSON data package that is returned

Attribute	Type	Description
errcode	number	Error code
errmsg	string	Error message
pager	Object	Information per page
data	Array.<string>	Record array

Valid values of errcode

Value	Description	Minimum Version
0	Request successful
-1	System Error
-1000	System Error
40014	Invalid AccessToken
40097	Invalid request parameter
40101	Required parameter missing
41001	AccessToken missing
42001	AccessToken expired
43002	HTTP METHOD error
44002	Empty POST BODY
47001	Incorrect format of POST BODY
85088	Cloud Base is not enabled on this App
Other error codes	Cloud Base error codes

Structure of pager

Attribute	Type	Description
Offset	number	Offset
Limit	number	Single query limit
Total	number	Number of records that meet the query condition

# Tips

Use limit() to limit the number of records per fetch in the query. It defaults to 10.

# Request Data Example

{
  "env":"test2-4a89da",
  "query": "db.collection(\"geo\").where({done:true}).limit(10).skip(1).get()"
}

# Return Data Example

{
    "errcode": 0,
    "errmsg": "ok",
    "pager": {
        "Offset": 1,
        "Limit": 10,
        "Total": 2
    },
    "data": [
        "{\"_id\":\"b15498af-1a5a-40b4-a4e7-b3fc4a1df482\",\"done\":true,\"name\":\"test\"}"
    ]
}

# Description of Database Operation Statements

Database operation statements use the same syntax with Database APIs