Skip to content

SearchIndexProps

Properties for defining a SearchIndex.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ots-searchindex

Initializer 

import { SearchIndexProps } from '@alicloud/ros-cdk-ots'
const searchIndexProps: SearchIndexProps = { ... }

Properties

Name Type Description
fieldSchemas @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | FieldSchemasProperty[] Property fieldSchemas: list of field_schema.
indexName string | @alicloud/ros-cdk-core.IResolvable Property indexName: The index name.
instanceName string | @alicloud/ros-cdk-core.IResolvable Property instanceName: The name of the OTS instance in which table will locate.
tableName string | @alicloud/ros-cdk-core.IResolvable Property tableName: The table name of the OTS instance.
indexSetting @alicloud/ros-cdk-core.IResolvable | IndexSettingProperty Property indexSetting: Index settings.
indexSort @alicloud/ros-cdk-core.IResolvable | IndexSortProperty Property indexSort: This parameter specifies how data is sorted.

fieldSchemasRequired 

public readonly fieldSchemas: IResolvable | IResolvable | FieldSchemasProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | FieldSchemasProperty[]

Property fieldSchemas: list of field_schema.

indexNameRequired 

public readonly indexName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property indexName: The index name.

instanceNameRequired 

public readonly instanceName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceName: The name of the OTS instance in which table will locate.

tableNameRequired 

public readonly tableName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property tableName: The table name of the OTS instance.

indexSettingOptional 

public readonly indexSetting: IResolvable | IndexSettingProperty;

Property indexSetting: Index settings.

indexSortOptional 

public readonly indexSort: IResolvable | IndexSortProperty;

Property indexSort: This parameter specifies how data is sorted.

By default, the data is sorted in the same way as the primary key of the table. If the search index contains NESTED fields, data is not sorted by default.