Skip to content

Commit

Permalink
catalog: add datasets.dataset.schema.table.columns.valueOptions
Browse files Browse the repository at this point in the history
It is for weight vector that is introduced since Groogna 4.0.1. (It is
not released yet.)
  • Loading branch information
kou committed Mar 14, 2014
1 parent 21cb9a8 commit e4d710d
Showing 1 changed file with 63 additions and 1 deletion.
64 changes: 63 additions & 1 deletion reference/catalog/version2/index.md
Expand Up @@ -37,6 +37,9 @@ This [`version`](#parameter-version) of `catalog` will be available from Droonga
"<Name of the column 1>": {
"type" : <"Scalar", "Vector" or "Index">,
"valueType" : "<Type of the value>",
"vectorOptions": {
"weight" : <Weight>,
},
"indexOptions" : {
"section" : <Section>,
"weight" : <Weight>,
Expand Down Expand Up @@ -418,6 +421,20 @@ Default value
Inheritable
: False.

##### `vectorOptions` {#parameter-vectorOptions}

Abstract
: Specifies the optional properties of a "Vector" column.

Value
: An object which is an [`vectorOptions` definition](#vectorOptions)

Default value
: `{}` (Void object).

Inheritable
: False.

##### `indexOptions` {#parameter-indexOptions}

Abstract
Expand Down Expand Up @@ -445,7 +462,21 @@ A scaler column to store `ShortText` values:
}
~~~

##### Example 2: Index column
##### Example 2: Vector column

A vector column to store `ShortText` values with weight:

~~~
{
"type": "Scalar",
"valueType": "ShortText",
"vectorOptions": {
"weight": true
}
}
~~~

##### Example 3: Index column

A column to index `address` column on `Store` table:

Expand All @@ -461,6 +492,37 @@ A column to index `address` column on `Store` table:
}
~~~

### vectorOptions definition {#vectorOptions}

Value
: An object with the following key/value pairs.

#### Parameters

##### `weight` {#parameter-vectorOptions-weight}

Abstract
: Specifies whether the vector column stores the weight data or not. Weight data is used for indicating the importance of the value.

Value
: A boolean value (`true` or `false`).

Default value
: `false`.

Inheritable
: False.

#### Example

Store the weight data.

~~~
{
"weight": true
}
~~~

### indexOption definition {#indexOption}

Value
Expand Down

0 comments on commit e4d710d

Please sign in to comment.