Sign in

v47

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

Create Database Collection

Create a Database Collection for your Organization. Each collection stores your data in the form of Documents which are structures of JSON Objects. You can run complex Queries on all the data that is present in a Collection.

post/api/collections/create

Request body

collectionstring

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

collectionSchemaobject

The Schema of the Collection. This is used to validate the data that is being stored in the Collection. This is optional. You can pass in the variables on how you want to structure the data as. We currently support Data Types such as string, number, float, boolean, date, timestamp, json, map, array, geopoint, uuid, ip.

collectionSortBystring

The Field by which you want to sort the data in the Collection. This is optional. By default we will sort it by the Document Creation Time of the data that you add.

Example request

{
  "collection": "Users",
  "collectionSchema": {
    "name": "string",
    "age": "number",
    "weight": "float",
    "is_active": "boolean",
    "date_of_birth": "date",
    "timestamp": "timestamp",
    "address": "json",
    "hobbies": "array",
    "location": "geopoint",
    "id": "uuid",
    "ip_address": "ip"
  },
  "collectionSortBy": "name"
}

Response

Output from the Database Creation 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,
  "database": {
    "collection": "Users",
    "elapsed_time": 800
  }
}