+ * This method is **EXPERIMENTAL** and its behavior, signature, or + * even its existence may change without prior notice in future versions. + * Use with caution.
+ * + * Sets the row metadata to use for this request. + * This is an optional parameter.
* * Row metadata is associated to a certain version of a row. Any subsequent * write operation will use its own row metadata value. If not specified - * null will be used by default.
- * - * The @parameter rowMetadata must be null or a valid JSON construct: - * object, array, string, number, true, false or null, otherwise an - * IllegalArgumentException is thrown. + * null will be used by default. + * NOTE that if you have previously written a record with metadata and a + * subsequent write does not supply metadata, the metadata associated with + * the row will be null. Therefore, if you wish to have metadata + * associated with every write operation, you must supply a valid JSON + * construct to this method.
* - * @param rowMetadata the row metadata + * @param rowMetadata the row metadata, must be null or a valid JSON + * construct: object, array, string, number, true, false or null, + * otherwise an IllegalArgumentException is thrown. * @throws IllegalArgumentException if rowMetadata not null and invalid - * JSON construct + * JSON construct * * @since 5.4.18 * @return this diff --git a/driver/src/main/java/oracle/nosql/driver/ops/GetResult.java b/driver/src/main/java/oracle/nosql/driver/ops/GetResult.java index d67681a3..7318eb8f 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/GetResult.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/GetResult.java @@ -86,6 +86,7 @@ public long getExpirationTime() { * or zero if the row does not exist * * @since 5.4.18 + * @hidden */ public long getCreationTime() { if (creationTime < 0 && client != null) { @@ -131,6 +132,10 @@ public GetResult setValue(MapValue value) { } /** + * This method is **EXPERIMENTAL** and its behavior, signature, or + * even its existence may change without prior notice in future versions. + * Use with caution.
+ * * Returns the metadata of the returned row, or null if the row does not * exist or metadata was not set. * @@ -143,7 +148,11 @@ public String getRowMetadata() { } /** - * Internal use only. + * This method is **EXPERIMENTAL** and its behavior, signature, or + * even its existence may change without prior notice in future versions. + * Use with caution.
+ * + * Internal use only.
* * Sets the rowMetadata of this object. * diff --git a/driver/src/main/java/oracle/nosql/driver/ops/MultiDeleteRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/MultiDeleteRequest.java index 55f28e2c..c990fa7d 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/MultiDeleteRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/MultiDeleteRequest.java @@ -235,20 +235,27 @@ public MultiDeleteRequest setNamespace(String namespace) { } /** - * Sets the row metadata to use for the operation. This is an optional + * This method is **EXPERIMENTAL** and its behavior, signature, or + * even its existence may change without prior notice in future versions. + * Use with caution.
+ * + * Sets the row metadata to use for this request. This is an optional * parameter.
* * Row metadata is associated to a certain version of a row. Any subsequent * write operation will use its own row metadata value. If not specified - * null will be used by default.
- * - * The @parameter rowMetadata must be null or a valid JSON construct: - * object, array, string, number, true, false or null, otherwise an - * IllegalArgumentException is thrown. - * - * @param rowMetadata the row metadata + * null will be used by default. + * NOTE that if you have previously written a record with metadata and a + * subsequent write does not supply metadata, the metadata associated with + * the row will be null. Therefore, if you wish to have metadata + * associated with every write operation, you must supply a valid JSON + * construct to this method.
+ * + * @param rowMetadata the row metadata, must be null or a valid JSON + * construct: object, array, string, number, true, false or null, + * otherwise an IllegalArgumentException is thrown. * @throws IllegalArgumentException if rowMetadata not null and invalid - * JSON construct + * JSON construct * * @return this * @since 5.4.18 diff --git a/driver/src/main/java/oracle/nosql/driver/ops/PutRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/PutRequest.java index 803446e9..9285f0b5 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/PutRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/PutRequest.java @@ -438,20 +438,27 @@ public int getIdentityCacheSize() { } /** - * Sets the row metadata to use for this request. - * This is an optional parameter.
+ * This method is **EXPERIMENTAL** and its behavior, signature, or + * even its existence may change without prior notice in future versions. + * Use with caution.
+ * + * Sets the row metadata to use for this request. This is an optional + * parameter.
* * Row metadata is associated to a certain version of a row. Any subsequent * write operation will use its own row metadata value. If not specified - * null will be used by default.
- * - * The @parameter rowMetadata must be null or a valid JSON construct: - * object, array, string, number, true, false or null, otherwise an - * IllegalArgumentException is thrown. - * - * @param rowMetadata the row metadata + * null will be used by default. + * NOTE that if you have previously written a record with metadata and a + * subsequent write does not supply metadata, the metadata associated with + * the row will be null. Therefore, if you wish to have metadata + * associated with every write operation, you must supply a valid JSON + * construct to this method.
+ * + * @param rowMetadata the row metadata, must be null or a valid JSON + * construct: object, array, string, number, true, false or null, + * otherwise an IllegalArgumentException is thrown. * @throws IllegalArgumentException if rowMetadata not null and invalid - * JSON construct + * JSON construct * * @since 5.4.18 * @return this diff --git a/driver/src/main/java/oracle/nosql/driver/ops/QueryRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/QueryRequest.java index 8b6da92b..eaab580c 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/QueryRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/QueryRequest.java @@ -925,23 +925,29 @@ public Consistency getConsistency() { } /** + * This method is **EXPERIMENTAL** and its behavior, signature, or + * even its existence may change without prior notice in future versions. + * Use with caution.
+ * * Sets the row metadata to use for the operation. This setting is optional * and only applies if the query modifies or deletes any rows using an * INSERT, UPDATE, UPSERT or DELETE statement. If the query is read-only - * this setting is ignored.
+ * this setting is ignored. This is an optional parameter.
* * Row metadata is associated to a certain version of a row. Any subsequent * write operation will use its own row metadata value. If not specified - * null will be used by default.
- * - * The @parameter rowMetadata must be null or a valid JSON construct: - * object, array, string, number, true, false or null, otherwise an - * IllegalArgumentException is thrown. - * - * @param rowMetadata the row metadata + * null will be used by default. + * NOTE that if you have previously written a record with metadata and a + * subsequent write does not supply metadata, the metadata associated with + * the row will be null. Therefore, if you wish to have metadata + * associated with every write operation, you must supply a valid JSON + * construct to this method.
+ * + * @param rowMetadata the row metadata, must be null or a valid JSON + * construct: object, array, string, number, true, false or null, + * otherwise an IllegalArgumentException is thrown. * @throws IllegalArgumentException if rowMetadata not null and invalid - * JSON construct - * + * JSON construct * @return this * @since 5.4.18 */ @@ -957,6 +963,10 @@ public QueryRequest setRowMetadata(String rowMetadata) { } /** + * This method is **EXPERIMENTAL** and its behavior, signature, or + * even its existence may change without prior notice in future versions. + * Use with caution.
+ * * Returns the row metadata set for this request, or null if not set. * * @return the row metadata diff --git a/driver/src/main/java/oracle/nosql/driver/ops/WriteRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/WriteRequest.java index 8ee03b92..7cfedb3b 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/WriteRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/WriteRequest.java @@ -55,9 +55,13 @@ protected void validateWriteRequest(String requestName) { } /** + * This method is **EXPERIMENTAL** and its behavior, signature, or + * even its existence may change without prior notice in future versions. + * Use with caution.
+ * * Returns the row metadata to be used for this request. * - * @return the metadata, or null if not set + * @return the row metadata, or null if not set * * @since 5.4.18 */ @@ -66,20 +70,27 @@ public String getRowMetadata() { } /** + * This method is **EXPERIMENTAL** and its behavior, signature, or + * even its existence may change without prior notice in future versions. + * Use with caution.
+ * * Sets the row metadata to use for this request. * This is an optional parameter.
* * Row metadata is associated to a certain version of a row. Any subsequent * write operation will use its own row metadata value. If not specified - * null will be used by default.
- * - * The @parameter rowMetadata must be null or in a valid JSON construct: - * object, array, string, number, true, false or null, - * otherwise an IllegalArgumentException is thrown. + * null will be used by default. + * NOTE that if you have previously written a record with metadata and a + * subsequent write does not supply metadata, the metadata associated with + * the row will be null. Therefore, if you wish to have metadata + * associated with every write operation, you must supply a valid JSON + * construct to this method.
* - * @param rowMetadata the row metadata + * @param rowMetadata the row metadata, must be null or a valid JSON + * construct: object, array, string, number, true, false or null, + * otherwise an IllegalArgumentException is thrown. * @throws IllegalArgumentException if rowMetadata not null and invalid - * JSON Object format + * JSON construct * * @since 5.4.18 * @return this