insertDocumentRequest

Object containing data for inserting a new document into the table

SearchFull-Text SearchVector SearchElasticsearch CompatibleOpen SourceDatabase

Properties

Name	Type	Description
table	string	Name of the table to insert the document into
cluster	string	Name of the cluster to insert the document into
id	integer	Document ID. If not provided, an ID will be auto-generated
doc	object	Object containing document data

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/manticore/main/json-schema/insertDocumentRequest.json",
  "title": "insertDocumentRequest",
  "description": "Object containing data for inserting a new document into the table\n",
  "type": "object",
  "required": [
    "table",
    "doc"
  ],
  "properties": {
    "table": {
      "type": "string",
      "description": "Name of the table to insert the document into"
    },
    "cluster": {
      "type": "string",
      "description": "Name of the cluster to insert the document into"
    },
    "id": {
      "type": "integer",
      "format": "uint64",
      "description": "Document ID. If not provided, an ID will be auto-generated\n"
    },
    "doc": {
      "type": "object",
      "additionalProperties": true,
      "description": "Object containing document data\n"
    }
  },
  "example": {
    "table": "test",
    "doc": {
      "title": "This is some title",
      "gid": 100
    }
  }
}