MLE-27304 Timestamp key is now optional for incremental write

Author: rjrudin

marklogic-client-api/src/main/java/com/marklogic/client/datamovement/filter/IncrementalWriteFilter.java

@@ -46,7 +46,7 @@ public static Builder newBuilder() {
 	public static class Builder {
 
 		private String hashKeyName = "incrementalWriteHash";
-		private String timestampKeyName = "incrementalWriteTimestamp";
+		private String timestampKeyName;
 		private boolean canonicalizeJson = true;
 		private Consumer<DocumentWriteOperation[]> skippedDocumentsConsumer;
 		private String[] jsonExclusions;
@@ -67,13 +67,11 @@ public Builder hashKeyName(String keyName) {
 		}
 
 		/**
-		 * @param keyName the name of the MarkLogic metadata key that will hold the timestamp value; defaults to "incrementalWriteTimestamp".
+		 * @param keyName the name of the MarkLogic metadata key that will hold the timestamp value;
+		 *                defaults to null, which means no timestamp will be stored.
 		 */
 		public Builder timestampKeyName(String keyName) {
-			// Don't let user shoot themselves in the foot with an empty key name.
-			if (keyName != null && !keyName.trim().isEmpty()) {
-				this.timestampKeyName = keyName;
-			}
+			this.timestampKeyName = keyName;
 			return this;
 		}
 
@@ -323,7 +321,9 @@ protected static DocumentWriteOperation addHashToMetadata(DocumentWriteOperation
 		}
 
 		newMetadata.getMetadataValues().put(hashKeyName, Long.toUnsignedString(hash));
-		newMetadata.getMetadataValues().put(timestampKeyName, timestamp);
+		if (timestampKeyName != null && !timestampKeyName.trim().isEmpty()) {
+			newMetadata.getMetadataValues().put(timestampKeyName, timestamp);
+		}
 
 		return new DocumentWriteOperationImpl(op.getUri(), newMetadata, op.getContent(), op.getTemporalDocumentURI());
 	}

marklogic-client-api/src/test/java/com/marklogic/client/datamovement/filter/AbstractIncrementalWriteTest.java

@@ -37,6 +37,7 @@ void setup() {
 		// Default filter implementation, should be suitable for most tests.
 		filter = IncrementalWriteFilter.newBuilder()
 			.onDocumentsSkipped(docs -> skippedCount.addAndGet(docs.length))
+			.timestampKeyName("incrementalWriteTimestamp")
 			.build();
 	}
 

marklogic-client-api/src/test/java/com/marklogic/client/datamovement/filter/IncrementalWriteTest.java

@@ -157,7 +157,8 @@ void customTimestampKeyName() {
 
 	/**
 	 * The thought for this test is that if the user passes null in (which could happen via our Spark connector),
-	 * they're breaking the feature. So don't let them do that - ignore null and use the default values.
+	 * they're breaking the feature. So don't let them do that - ignore null and use the default value for the hash
+	 * key name - but null is still valid for the timestamp key name as that's an optional value to set.
 	 */
 	@Test
 	void nullIsIgnoredForKeyNames() {
@@ -172,7 +173,7 @@ void nullIsIgnoredForKeyNames() {
 			new DocumentMetadataHandle());
 
 		assertNotNull(metadata.getMetadataValues().get("incrementalWriteHash"));
-		assertNotNull(metadata.getMetadataValues().get("incrementalWriteTimestamp"));
+		assertFalse(metadata.getMetadataValues().containsKey("incrementalWriteTimestamp"));
 	}
 
 	@Test
@@ -219,6 +220,7 @@ void binaryDocument() {
 	void fromView() {
 		filter = IncrementalWriteFilter.newBuilder()
 			.fromView("javaClient", "incrementalWriteHash")
+			.timestampKeyName("incrementalWriteTimestamp")
 			.onDocumentsSkipped(docs -> skippedCount.addAndGet(docs.length))
 			.build();
 
@@ -275,6 +277,7 @@ void emptyValuesForFromView() {
 			// Empty/null values are ignored, as long as both schema/view are empty/null. This makes life a little
 			// easier for a connector in that the connector does not need to check for empty/null values.
 			.fromView("", null)
+			.timestampKeyName("incrementalWriteTimestamp")
 			.onDocumentsSkipped(docs -> skippedCount.addAndGet(docs.length))
 			.build();