Ali Alsuliman has uploaded a new change for review.
https://asterix-gerrit.ics.uci.edu/3015
Change subject: [ASTERIXDB-2463][DOC] add docs for primary index & parallel
sort parameters - user model changes: no - storage format changes: no -
interface changes: no
......................................................................
[ASTERIXDB-2463][DOC] add docs for primary index & parallel sort parameters
- user model changes: no
- storage format changes: no
- interface changes: no
details:
add docs for primary index & parallel sort parameters
Change-Id: Iaad725f7104da7f70b1064ffda90e5397b3094ec
---
M asterixdb/asterix-doc/src/main/markdown/sqlpp/5_ddl_dataset_index.md
M asterixdb/asterix-doc/src/site/markdown/ncservice.md
2 files changed, 19 insertions(+), 3 deletions(-)
git pull ssh://asterix-gerrit.ics.uci.edu:29418/asterixdb
refs/changes/15/3015/1
diff --git
a/asterixdb/asterix-doc/src/main/markdown/sqlpp/5_ddl_dataset_index.md
b/asterixdb/asterix-doc/src/main/markdown/sqlpp/5_ddl_dataset_index.md
index 589b038..99f8611 100644
--- a/asterixdb/asterix-doc/src/main/markdown/sqlpp/5_ddl_dataset_index.md
+++ b/asterixdb/asterix-doc/src/main/markdown/sqlpp/5_ddl_dataset_index.md
@@ -192,9 +192,11 @@
### <a id="Indices">Indices</a>
- IndexSpecification ::= <INDEX> Identifier IfNotExists <ON> QualifiedName
+ IndexSpecification ::= (<INDEX> Identifier IfNotExists <ON> QualifiedName
"(" ( IndexField ) ( "," IndexField )* ")" ( "type"
IndexType "?")?
- ( (<NOT>)? <ENFORCED> )?
+ ( (<NOT>)? <ENFORCED> )?)
+ |
+ <PRIMARY> <INDEX> Identifier? IfNotExists <ON>
QualifiedName (<TYPE> <BTREE>)?
IndexType ::= <BTREE> | <RTREE> | <KEYWORD> | <NGRAM> "("
IntegerLiteral ")"
The CREATE INDEX statement creates a secondary index on one or more fields of
a specified dataset.
@@ -252,3 +254,15 @@
#### Example
CREATE INDEX fbMessageIdx ON GleambookMessages(message) TYPE KEYWORD;
+
+#### Primary Index
+`CREATE PRIMARY INDEX` creates a special secondary index which holds only the
primary keys.
+This index is useful for speeding up aggregation queries which involve only
primary keys.
+
+##### Examples
+
+ CREATE PRIMARY INDEX ON GleambookMessages;
+ CREATE PRIMARY INDEX gb_pi_idx ON GleambookMessages;
+
+An example query that can be accelerated using the primary index:<br />
+`SELECT COUNT(*) FROM GleambookMessages;`
\ No newline at end of file
diff --git a/asterixdb/asterix-doc/src/site/markdown/ncservice.md
b/asterixdb/asterix-doc/src/site/markdown/ncservice.md
index ef2ac9b..66e99a8 100644
--- a/asterixdb/asterix-doc/src/site/markdown/ncservice.md
+++ b/asterixdb/asterix-doc/src/site/markdown/ncservice.md
@@ -345,7 +345,9 @@
| common | compiler.joinmemory | The memory budget (in
bytes) for a join operator instance in a partition | 33554432 (32 MB) |
| common | compiler.parallelism | The degree of
parallelism for query execution. Zero means to use the storage parallelism as
the query execution parallelism, while other integer values dictate the number
of query execution parallel partitions. The system will fall back to use the
number of all available CPU cores in the cluster as the degree of parallelism
if the number set by a user is too large or too small | 0 |
| common | compiler.sortmemory | The memory budget (in
bytes) for a sort operator instance in a partition | 33554432 (32 MB) |
-| common | compiler.textsearchmemory | The memory
budget (in bytes) for an inverted-index-search operator instance in a partition
| 33554432 (32 MB) |
+| common | compiler.sort.parallel | Enable full parallel
sort for queries | true |
+| common | compiler.sort.samples | The number of samples
taken from each partition to guide the sort operation when full parallel sort
is enabled | 100 |
+| common | compiler.textsearchmemory | The memory budget (in
bytes) for an inverted-index-search operator instance in a partition | 33554432
(32 MB) |
| common | log.level | The logging level for
master and slave processes | WARNING |
| common | max.wait.active.cluster | The max pending time
(in seconds) for cluster startup. After the threshold, if the cluster still is
not up and running, it is considered unavailable | 60 |
| common | messaging.frame.count | Number of reusable
frames for NC to NC messaging | 512 |
--
To view, visit https://asterix-gerrit.ics.uci.edu/3015
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Iaad725f7104da7f70b1064ffda90e5397b3094ec
Gerrit-PatchSet: 1
Gerrit-Project: asterixdb
Gerrit-Branch: master
Gerrit-Owner: Ali Alsuliman <[email protected]>
