IntenseFinance/nosqlbench
3
0 Fork 0
mirror of https://github.com/nosqlbench/nosqlbench.git synced 2026-10-13 09:52:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

last touches to the self-documenting all-ops yamls

Browse Source
This commit is contained in:
Stefano Lottini committed 2026-09-28 10:30:22 +02:00
1 parent 401489148a
commit 339aa7b94d
2 files changed
+48 -46
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

nb-adapters/adapter-dataapi/src/main/resources/activities/legacy_ops_reference.yaml
+31 -27
View File
@@ -2,7 +2,7 @@
# It is not a full NB workload file. Refer to the full examples for the overall format.
blocks:
bl_do_debug:
my_block:
ops:
# LEGACY "deleteCollection", fully documented:
@@ -119,7 +119,7 @@ blocks:
# type: "asc"
# field: "idx"
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector_w}"
# vector: [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
#### optional projection (either include or exclude, list of fields):
@@ -148,7 +148,7 @@ blocks:
# type: "asc"
# field: "idx"
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector_w}"
# vector: [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
#### optional projection (either include or exclude, list of fields):
@@ -174,7 +174,7 @@ blocks:
# type: "asc"
# field: "idx"
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector_w}"
# vector: [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
#### optional projection (either include or exclude, list of fields):
@@ -186,9 +186,9 @@ blocks:
u1_legacy:
update_one: "TEMPLATE(collection)"
#### required update (free-form):
# update:
# $set:
# updated: true
update:
$set:
updated: true
#### optional filter (either all 'and' or all 'or'):
# filters:
# - conjunction: "and"
@@ -202,7 +202,7 @@ blocks:
# type: "asc"
# field: "idx"
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector_w}"
# vector: [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
@@ -250,7 +250,7 @@ blocks:
# type: "asc"
# field: "idx"
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector_w}"
# vector: [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
@@ -274,7 +274,7 @@ blocks:
# type: "asc"
# field: "idx"
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector_w}"
# vector: [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
#### optional projection (either include or exclude, list of fields):
@@ -288,7 +288,7 @@ blocks:
find_vector_legacy:
find_vector: "TEMPLATE(collection)"
#### required sort vector (float list/string repr with commas):
vector: "{seq_vector}"
vector: [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]
#### optional, limit (defaults to 100):
# limit: 3
@@ -296,7 +296,7 @@ blocks:
find_vector_filter_legacy:
find_vector_filter: "TEMPLATE(collection)"
#### required sort vector (float list/string repr with commas):
vector: "{seq_vector}"
vector: [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]
#### optional filter (either all 'and' or all 'or'):
# filters:
# - conjunction: "and"
@@ -326,7 +326,7 @@ blocks:
# type: "asc"
# field: "idx"
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector_w}"
# vector: [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
#### optional projection (either include or exclude, list of fields):
@@ -351,7 +351,7 @@ blocks:
# type: "asc"
# field: "idx"
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector_w}"
# vector: [1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
#### optional filter (either all 'and' or all 'or'):
@@ -382,22 +382,26 @@ blocks:
create_collection_with_class: "TEMPLATE(collection_to_create)"
#### required class name for the collection instance returned (default is shown):
createClass: "com.datastax.astra.client.collections.definition.documents.Document"
#### optional vector dimension:
### optional vector dimensionality (if present, it's a vector collection. Note plural, 'dimensions'):
# dimensions: 1024
#### optional similarity function (for vector):
# similarity: "DOT_PRODUCT"
#### optional default ID type:
# collectionType: objectId
#### optional vectorize provider:
#### optional similarity function for vector (case-insensitive "COSINE"/"EUCLIDEAN"/"DOT_PRODUCT"):
# similarity: DOT_PRODUCT
#### optional (required for vectorize) service provider:
# serviceProvider: voyageAI
#### optional vectorize model (note the param typo, 'Mode'):
# serviceMode: "voyage-2"
#### optional embedding API key name in KMS:
#### optional (required for vectorize) service model (note a typo, 'mode'):
# serviceMode: voyage-2
#### optional KMS secret name for vectorize API key:
# serviceSharedSecretKey: SHARED_SECRET_EMBEDDING_API_KEY_VOYAGEAI
#### optional parameters for the embedding service (depend on model):
#### optional parameters map for vectorize service/model:
# serviceParameters:
# autoTruncate: true
#### optional selective indexing (only one of 'allowIndex'/'denyIndex'):
#### optional default ID type (case-sensitive "objectId"/"uuidv6"/"uuidv7"/"uuid"):
# collectionType: objectId
#### optional, allow-list for indexing (error if denyIndex present as well):
# allowIndex:
# - field1
# - field2
# - aField1
# - aField2
#### optional, deny-list for indexing (error if allowIndex present as well):
# denyIndex:
# - aField1
# - aField2
nb-adapters/adapter-dataapi/src/main/resources/activities/ops_reference.yaml
+17 -19
View File
@@ -2,7 +2,7 @@
# It is not a full NB workload file. Refer to the full examples for the overall format.
blocks:
bl_do_debug:
my_block:
ops:
# NEW "deleteCollection", fully documented:
@@ -59,17 +59,15 @@ blocks:
document:
newv2: true
# $vector: [1,2,3,4,5,6,7,8,9,0]
# $vector:
# $binary: "P4AAAD+AAAA/gAAAP4AAAD+AAAA/gAAAP4AAAD+AAAA/gAAAP4AAAA=="
# NEW "updateMany", fully documented:
um:
collection_update_many: "TEMPLATE(collection)"
#### (Note: may fail to update more than first page until fix to https://github.com/datastax/astra-db-java/issues/106 is released)
#### required update (free-form):
# update:
# $set:
# updated: "yes!"
update:
$set:
updated: "yes!"
#### optional filter (free-form):
# filter:
# $and:
@@ -101,7 +99,7 @@ blocks:
# block: asc
# idx: desc
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector}"
# vector: [1,2,3,4,5,6,7,8,9,0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
#### optional projection (lists of fields; include and exclude can coexist only for special fields):
@@ -124,7 +122,7 @@ blocks:
# block: asc
# idx: desc
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector}"
# vector: [1,2,3,4,5,6,7,8,9,0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
#### optional projection (lists of fields; include and exclude can coexist only for special fields):
@@ -152,7 +150,7 @@ blocks:
# block: asc
# idx: desc
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector}"
# vector: [1,2,3,4,5,6,7,8,9,0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
@@ -193,7 +191,7 @@ blocks:
# block: asc
# idx: desc
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector}"
# vector: [1,2,3,4,5,6,7,8,9,0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
@@ -212,7 +210,7 @@ blocks:
# block: asc
# idx: desc
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector_w}"
# vector: [1,2,3,4,5,6,7,8,9,0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
#### optional limit:
@@ -235,15 +233,15 @@ blocks:
#### optional filter (free-form):
# filter:
# $and:
# - field1: "{the_value}"
# - field1: "value1"
# - field2:
# $eq: "{the_value}"
# $eq: 123
#### optional sort (order matters; can't use if 'vector/ize'):
# sort:
# block: asc
# idx: desc
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector_w}"
# vector: [1,2,3,4,5,6,7,8,9,0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
#### optional projection (lists of fields; include and exclude can coexist only for special fields):
@@ -257,7 +255,7 @@ blocks:
# NEW "findOneAndUpdate". Fully documented:
f1upd:
collection_find_one_and_update: "TEMPLATE(collection)"
#### required update
#### required update (free-form):
update:
$set:
myfield2: "new_val"
@@ -269,15 +267,15 @@ blocks:
# block: asc
# idx: desc
#### optional vector (not if 'sort/vectorize'; float list/string repr with commas):
# vector: "{seq_vector_w}"
# vector: [1,2,3,4,5,6,7,8,9,0]
#### optional vectorize (not if 'sort/vector'):
# vectorize: "query string"
#### optional filter (free-form):
# filter:
# $and:
# - field1: "{the_value}"
# - field1: "value1"
# - field2:
# $eq: "{the_value}"
# $eq: 123
#### optional upsert:
# upsert: true
@@ -332,7 +330,7 @@ blocks:
#### optional includeSortVector (default false):
# include_sort_vector: true
#### optional rerank override for this one call:
#### (Note: may not work until fix to https://github.com/datastax/astra-db-java/issues/109 released)
#### (Note: may not have effects until fix to https://github.com/datastax/astra-db-java/issues/109 released)
# rerank:
# provider: theProvider"
# modelName: "theModelName"