Ian Maxon has submitted this change and it was merged. Change subject: Minor change in documentation related to open field indexing (including a non-terminal name change in the documented grammar). ......................................................................
Minor change in documentation related to open field indexing (including a non-terminal name change in the documented grammar). Change-Id: Iaf647dc48c3f4d5b9bcb09ad198b815959cde2d5 Reviewed-on: https://asterix-gerrit.ics.uci.edu/417 Reviewed-by: Ian Maxon <[email protected]> Tested-by: Jenkins <[email protected]> --- M asterix-doc/src/site/markdown/aql/manual.md 1 file changed, 6 insertions(+), 6 deletions(-) Approvals: Ian Maxon: Looks good to me, approved Jenkins: Verified diff --git a/asterix-doc/src/site/markdown/aql/manual.md b/asterix-doc/src/site/markdown/aql/manual.md index 3280fca..77c9aa1 100644 --- a/asterix-doc/src/site/markdown/aql/manual.md +++ b/asterix-doc/src/site/markdown/aql/manual.md @@ -548,7 +548,7 @@ RecordTypeDef ::= ( "closed" | "open" )? "{" ( RecordField ( "," RecordField )* )? "}" RecordField ::= Identifier ":" ( TypeExpr ) ( "?" )? NestedField ::= Identifier ( "." Identifier )* - OpenField ::= NestedField ( ":" TypeReference )? + IndexField ::= NestedField ( ":" TypeReference )? TypeReference ::= Identifier OrderedListTypeDef ::= "[" ( TypeExpr ) "]" UnorderedListTypeDef ::= "{{" ( TypeExpr ) "}}" @@ -675,7 +675,7 @@ #### Indices IndexSpecification ::= "index" Identifier IfNotExists "on" QualifiedName - "(" ( OpenField ) ( "," OpenField )* ")" ( "type" IndexType )? ( "enforced" )? + "(" ( IndexField ) ( "," IndexField )* ")" ( "type" IndexType )? ( "enforced" )? IndexType ::= "btree" | "rtree" | "keyword" @@ -684,11 +684,11 @@ The create index statement creates a secondary index on one or more fields of a specified dataset. Supported index types include `btree` for totally ordered datatypes, `rtree` for spatial data, and `keyword` and `ngram` for textual (string) data. -Index could be created on arbitrary nested fields by providing valid path expression as an indexed field identifier. +An index can be created on a nested field (or fields) by providing a valid path expression as an index field identifier. An index field is not required to be part of the datatype associated with a dataset if that datatype is declared as -open, field type is provided along with it's type and `enforced` keyword is specified in the end of index definition. -`Enforcing` an open field will introduce a load-time check, which will make sure that the actual type of an indexed -field (if such field exists in the record) matches the specified field type. +open and the field's type is provided along with its type and the `enforced` keyword is specified in the end of index definition. +`Enforcing` an open field will introduce a check that will make sure that the actual type of an indexed +field (if the field exists in the record) always matches this specified (open) field type. The following example creates a btree index called fbAuthorIdx on the author-id field of the FacebookMessages dataset. This index can be useful for accelerating exact-match queries, range search queries, and joins involving the author-id field. -- To view, visit https://asterix-gerrit.ics.uci.edu/417 To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings Gerrit-MessageType: merged Gerrit-Change-Id: Iaf647dc48c3f4d5b9bcb09ad198b815959cde2d5 Gerrit-PatchSet: 2 Gerrit-Project: asterixdb Gerrit-Branch: master Gerrit-Owner: Till Westmann <[email protected]> Gerrit-Reviewer: Ian Maxon <[email protected]> Gerrit-Reviewer: Jenkins <[email protected]>
