v47

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2024-06-17465244.2 KB

Database Management

Run Simple and Compound Queries on a Collection

Run Simple and Compound Queries on a Collection. You can run a simple WHERE query or a compound AND or OR query on a Collection. This is useful when you want to fetch a specific Document from a Collection and perform some operations on it. You can also sort the response in a specific order of asc or desc on the basis of the Field/Key that you pass in and limit the number of Documents that you want to fetch.

post/api/collections/data/fetch/query

Request body

collectionstring

The Name of the Collection or the Group where you want to store all your data.

compounding'and' | 'or'

The Compounding Operator that you want to run the query with. This is optional. By default we will run the query with the and operator if you pass multiple queries. If you add a compounding parameter, we will run the query with that Compounding Operator.

orderBystring

The Field/Key that you want to sort the response by. This is optional. By default we will sort it by the Field/Key that you pass in as default orderBy value when collection was created. If you add a orderBy Field/Key, we will sort the response by that Field/Key.

orderType'asc' | 'desc'

The Order Type that you want to sort the response by. This is optional. By default we will sort it in asc order. If you add a orderType Field/Key, we will sort the response by that Order Type on the orderBy Field/Key.

limitinteger

The Limit of the number of Documents that you want to fetch. This is optional. By default we will fetch all the Documents that match the query. If you add a limit Field/Key, we will limit the response by that number.

startAfterstring

The number of documents to skip. This is optional. By default we will not skip any documents. If you add a startAfter value, we will skip the number of documents that you pass in.

outputType'json' | 'stream' | 'file'

The type of output you want. json will return the data as a JSON object that is parseable. stream will return the data as a stream of data and file will return the data as a parseable CSV file.

Example request

{
  "collection": "Users",
  "queries": [
    {
      "field": "name",
      "operator": "equal to",
      "value": "Alex"
    },
    {
      "field": "age",
      "operator": "greater than",
      "value": 18
    }
  ],
  "compounding": "and",
  "orderBy": "age",
  "orderType": "desc",
  "limit": 10,
  "startAfter": 5,
  "outputType": "json"
}

Response

Output from the Database Collection Fetch Process

statusstring

Status indicating the success of the text moderation.

processing_timeinteger

The time taken to process the request, in milliseconds.

processing_idstring

A universally unique identifier for the request. This can be used to track the request in the logs.

processing_countinteger

The number of times the request has been processed. This is what is considered in the Billing Process. This is either the number of times the image is processed or the number of words that the server processes.

Example response

{
  "status": "success",
  "processing_time": 888,
  "processing_id": "4b139bfe-1f71-4345-b539-fa6c1700f166",
  "processing_count": 6554,
  "data": {
    "databaseId": "1234567890",
    "collection": "Users",
    "elapsed_time": 800,
    "data": [
      {
        "sampleDbContent": "This is a sample content",
        "sampleDbContent2": "This is a sample content 2"
      },
      {
        "sampleDbContent": "This is a sample content",
        "sampleDbContent2": "This is a sample content 2"
      }
    ]
  }
}