Skip to content
XapiandXapiand

Schema Metadata

Edit page

A Schema can have custom meta data associated with it. These are not used at all by Xapiand, but can be used to store application-specific metadata, such as the class that a document belongs to or schema descriptions.

The _meta field can be updated on an existing type using the Create Index API:

PUT /my_index/


{
  "_schema": {
    "_meta": {
      "description": "Schema description here",
      "class": "MyApp::User",
      "version": {
        "min": "1.0",
        "max": "1.3"
      }
    }
  }
}

This _meta info can be retrieved with the Get Index API:

GET /my_index/._schema._meta