ILP v4 -> QWP v1

Author: mtopolnik

core/src/main/java/io/questdb/client/Sender.java

@@ -474,7 +474,7 @@ enum Transport {
         /**
          * Use WebSocket transport to communicate with a QuestDB server.
          * <p>
-         * WebSocket transport uses the ILP v4 binary protocol for efficient data ingestion.
+         * WebSocket transport uses the QWP v1 binary protocol for efficient data ingestion.
          * It supports both synchronous and asynchronous modes with flow control.
          */
         WEBSOCKET
@@ -1391,6 +1391,17 @@ private static RuntimeException rethrow(Throwable t) {
             throw new LineSenderException(t);
         }
 
+        private String buildWebSocketAuthHeader() {
+            if (username != null && password != null) {
+                String credentials = username + ":" + password;
+                return "Basic " + Base64.getEncoder().encodeToString(credentials.getBytes(StandardCharsets.UTF_8));
+            }
+            if (httpToken != null) {
+                return "Bearer " + httpToken;
+            }
+            return null;
+        }
+
         private void configureDefaults() {
             if (protocol == PARAMETER_NOT_SET_EXPLICITLY) {
                 protocol = PROTOCOL_TCP;
@@ -1797,17 +1808,6 @@ private void validateParameters() {
             }
         }
 
-        private String buildWebSocketAuthHeader() {
-            if (username != null && password != null) {
-                String credentials = username + ":" + password;
-                return "Basic " + Base64.getEncoder().encodeToString(credentials.getBytes(StandardCharsets.UTF_8));
-            }
-            if (httpToken != null) {
-                return "Bearer " + httpToken;
-            }
-            return null;
-        }
-
         private void websocket() {
             if (protocol != PARAMETER_NOT_SET_EXPLICITLY) {
                 throw new LineSenderException("protocol was already configured ")

core/src/main/java/io/questdb/client/cutlass/qwp/client/NativeBufferWriter.java

@@ -29,7 +29,7 @@
 import io.questdb.client.std.Unsafe;
 
 /**
- * A simple native memory buffer writer for encoding ILP v4 messages.
+ * A simple native memory buffer writer for encoding QWP v1 messages.
  * <p>
  * This class provides write methods similar to HttpClient.Request but writes
  * to a native memory buffer that can be sent over WebSocket.

core/src/main/java/io/questdb/client/cutlass/qwp/client/QwpBufferWriter.java

@@ -27,10 +27,10 @@
 import io.questdb.client.cutlass.line.array.ArrayBufferAppender;
 
 /**
- * Buffer writer interface for ILP v4 message encoding.
+ * Buffer writer interface for QWP v1 message encoding.
  * <p>
  * This interface extends {@link ArrayBufferAppender} with additional methods
- * required for encoding ILP v4 messages, including varint encoding, string
+ * required for encoding QWP v1 messages, including varint encoding, string
  * handling, and buffer manipulation.
  * <p>
  * Implementations include:

core/src/main/java/io/questdb/client/cutlass/qwp/client/QwpWebSocketEncoder.java

@@ -34,7 +34,7 @@
 import static io.questdb.client.cutlass.qwp.protocol.QwpConstants.*;
 
 /**
- * Encodes ILP v4 messages for WebSocket transport.
+ * Encodes QWP v1 messages for WebSocket transport.
  * <p>
  * This encoder reads column data from off-heap {@link io.questdb.client.cutlass.qwp.protocol.OffHeapAppendMemory}
  * buffers in {@link QwpTableBuffer.ColumnBuffer} and uses bulk {@code putBlockOfBytes} for fixed-width

core/src/main/java/io/questdb/client/cutlass/qwp/client/QwpWebSocketSender.java

@@ -53,7 +53,7 @@
 
 
 /**
- * ILP v4 WebSocket client sender for streaming data to QuestDB.
+ * QWP v1 WebSocket client sender for streaming data to QuestDB.
  * <p>
  * This sender uses a double-buffering scheme with asynchronous I/O for high throughput:
  * <ul>
@@ -123,7 +123,7 @@ public class QwpWebSocketSender implements Sender {
     // Auto-flush configuration
     private final int autoFlushRows;
     private final Decimal256 currentDecimal256 = new Decimal256();
-    // Encoder for ILP v4 messages
+    // Encoder for QWP v1 messages
     private final QwpWebSocketEncoder encoder;
     // Global symbol dictionary for delta encoding
     private final GlobalSymbolDictionary globalSymbolDictionary;
@@ -1088,7 +1088,7 @@ private void failExpectedIfNeeded(long expectedSequence, LineSenderException err
 
     /**
      * Flushes pending rows by encoding and sending them.
-     * Each table's rows are encoded into a separate ILP v4 message and sent as one WebSocket frame.
+     * Each table's rows are encoded into a separate QWP v1 message and sent as one WebSocket frame.
      */
     private void flushPendingRows() {
         if (pendingRowCount <= 0) {
@@ -1139,7 +1139,7 @@ private void flushPendingRows() {
                 QwpBufferWriter buffer = encoder.getBuffer();
 
                 // Copy to microbatch buffer and seal immediately
-                // Each ILP v4 message must be in its own WebSocket frame
+                // Each QWP v1 message must be in its own WebSocket frame
                 activeBuffer.ensureCapacity(messageSize);
                 activeBuffer.write(buffer.getBufferPtr(), messageSize);
                 activeBuffer.incrementRowCount();

core/src/main/java/io/questdb/client/cutlass/qwp/client/WebSocketResponse.java

@@ -29,7 +29,7 @@
 import java.nio.charset.StandardCharsets;
 
 /**
- * Binary response format for WebSocket ILP v4 protocol.
+ * Binary response format for WebSocket QWP v1 protocol.
  * <p>
  * Response format (little-endian):
  * <pre>

core/src/main/java/io/questdb/client/cutlass/qwp/protocol/QwpBitWriter.java

@@ -28,7 +28,7 @@
 import io.questdb.client.std.Unsafe;
 
 /**
- * Bit-level writer for ILP v4 protocol.
+ * Bit-level writer for QWP v1 protocol.
  * <p>
  * This class writes bits to a buffer in LSB-first order within each byte.
  * Bits are packed sequentially, spanning byte boundaries as needed.

core/src/main/java/io/questdb/client/cutlass/qwp/protocol/QwpColumnDef.java

@@ -28,7 +28,7 @@
 import static io.questdb.client.cutlass.qwp.protocol.QwpConstants.TYPE_CHAR;
 
 /**
- * Represents a column definition in an ILP v4 schema.
+ * Represents a column definition in an QWP v1 schema.
  * <p>
  * This class is immutable and safe for caching.
  */
@@ -41,7 +41,7 @@ public final class QwpColumnDef {
      * Creates a column definition.
      *
      * @param name     the column name (UTF-8)
-     * @param typeCode the ILP v4 type code (0x01-0x0F, optionally OR'd with 0x80 for nullable)
+     * @param typeCode the QWP v1 type code (0x01-0x0F, optionally OR'd with 0x80 for nullable)
      */
     public QwpColumnDef(String name, byte typeCode) {
         this.name = name;

core/src/main/java/io/questdb/client/cutlass/qwp/protocol/QwpConstants.java

@@ -25,7 +25,7 @@
 package io.questdb.client.cutlass.qwp.protocol;
 
 /**
- * Constants for the ILP v4 binary protocol.
+ * Constants for the QWP v1 binary protocol.
  */
 public final class QwpConstants {
 

core/src/main/java/io/questdb/client/cutlass/qwp/protocol/QwpGorillaEncoder.java

@@ -28,7 +28,7 @@
 import io.questdb.client.std.Unsafe;
 
 /**
- * Gorilla delta-of-delta encoder for timestamps in ILP v4 format.
+ * Gorilla delta-of-delta encoder for timestamps in QWP v1 format.
  * <p>
  * This encoder is used by the WebSocket encoder to compress timestamp columns.
  * It uses delta-of-delta compression where: