Opensearch dashboards.savedobjectsservicesetup.registertype
Home > opensearch-dashboards > SavedObjectsServiceSetup > registerType
SavedObjectsServiceSetup.registerType property
Register a savedObjects type definition.
See the mappings format and migration format for more details about these.
Signature:
registerType: (type: SavedObjectsType) => void;
Example
// src/plugins/my_plugin/server/saved_objects/my_type.ts
import { SavedObjectsType } from 'src/core/server';
import * as migrations from './migrations';
export const myType: SavedObjectsType = {
name: 'MyType',
hidden: false,
namespaceType: 'multiple',
mappings: {
properties: {
textField: {
type: 'text',
},
boolField: {
type: 'boolean',
},
},
},
migrations: {
'2.0.0': migrations.migrateToV2,
'2.1.0': migrations.migrateToV2_1
},
};
// src/plugins/my_plugin/server/plugin.ts
import { SavedObjectsClient, CoreSetup } from 'src/core/server';
import { myType } from './saved_objects';
export class Plugin() {
setup: (core: CoreSetup) => {
core.savedObjects.registerType(myType);
}
}