asterixdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Carey (Code Review)" <do-not-re...@asterix-gerrit.ics.uci.edu>
Subject Change in asterixdb[master]: Minor change in documentation related to open field indexing...
Date Fri, 24 Jul 2015 23:47:21 GMT
Michael Carey has uploaded a new change for review.

  https://asterix-gerrit.ics.uci.edu/328

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: I5c4cb8fea7b534f72468cd454934df0f7dae213b
---
M asterix-doc/src/site/markdown/aql/manual.md
1 file changed, 6 insertions(+), 6 deletions(-)


  git pull ssh://asterix-gerrit.ics.uci.edu:29418/asterixdb refs/changes/28/328/1

diff --git a/asterix-doc/src/site/markdown/aql/manual.md b/asterix-doc/src/site/markdown/aql/manual.md
index 3968330..4ee1c2b 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 ) "}}"
@@ -659,7 +659,7 @@
 #### Indices
 
     IndexSpecification ::= "index" Identifier IfNotExists "on" QualifiedName 
-                           "(" ( OpenField ) ( "," OpenField )* ")" ( "type" IndexType )?
( "enforced" )?
+                           "(" ( IndexField ) ( "," IndexField )* ")" ( "type" IndexType
)? ( "enforced" )?
     IndexType          ::= "btree"
                          | "rtree"
                          | "keyword"
@@ -668,11 +668,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 name 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 index
+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/328
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I5c4cb8fea7b534f72468cd454934df0f7dae213b
Gerrit-PatchSet: 1
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Michael Carey <dtabass@gmail.com>
Gerrit-Reviewer: Ian Maxon <imaxon@apache.org>
Gerrit-Reviewer: Jenkins <jenkins@fulliautomatix.ics.uci.edu>

Mime
View raw message