Merge pull request #50 from SpringQL/build/0.14.0

build: 0.14.0

Author: laysakura

CHANGELOG.md

@@ -13,6 +13,20 @@ Also check the changes in springql-core: <https://github.com/SpringQL/SpringQL/b
 <!-- markdownlint-disable MD024 -->
 ## [Unreleased]
 
+## [v0.14.0] - 2022-06-24
+
+### Changed
+
+- `SpringRow` into `SpringSinkRow` ([#50](https://github.com/SpringQL/SpringQL-client-c/pull/50))
+- `spring_row_close` -> `spring_sink_row_close` ([#50](https://github.com/SpringQL/SpringQL-client-c/pull/50))
+
+### Added
+
+- Following new APIs: ([#50](https://github.com/SpringQL/SpringQL-client-c/pull/50))
+  - `SpringSourceRow`
+  - `spring_source_row_from_json`
+  - `spring_source_row_close`
+
 ## [v0.13.0+4]
 
 ### Fixed

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "springql-client-c"
-version = "0.13.0+4"
+version = "0.14.0"
 
 authors = ["Sho Nakatani <lay.sakura@gmail.com>"]
 license = "MIT OR Apache-2.0"
@@ -15,6 +15,6 @@ name = "springql_client"
 cbindgen = "0.24"
 
 [dependencies]
-springql-core = "0.13.0"
+springql = "0.14.0"
 
 log = "0.4"

c_example/doc_app1/doc_app1.c

@@ -91,7 +91,7 @@ int main()
 
     fprintf(stderr, "waiting JSON records in tcp/54300...\n");
 
-    SpringRow *row;
+    SpringSinkRow *row;
     while (1)
     {
         row = spring_pop(pipeline, "q");
@@ -108,7 +108,7 @@ int main()
         assert_ok(ret);
 
         fprintf(stderr, "%s\t%f\n", ts, temperature_fahrenheit);
-        spring_row_close(row);
+        spring_sink_row_close(row);
     }
 
     ret = spring_close(pipeline);

c_example/doc_app2/doc_app2.c

@@ -137,7 +137,7 @@ int main()
 
     fprintf(stderr, "waiting JSON records in tcp/54300...\n");
 
-    SpringRow *row;
+    SpringSinkRow *row;
     bool is_err = false;
     while (1)
     {
@@ -159,7 +159,7 @@ int main()
                 assert_ok(ret);
 
                 fprintf(stderr, "[q_avg_all] %s\t%f\n", ts, avg_amount);
-                spring_row_close(row);
+                spring_sink_row_close(row);
             }
             else
             {
@@ -182,7 +182,7 @@ int main()
             assert_ok(ret);
 
             fprintf(stderr, "[q_avg_by_symbol] %s\t%s\t%f\n", ts, symbol, avg_amount);
-            spring_row_close(row);
+            spring_sink_row_close(row);
         }
         else
         {

c_example/trade_projection/trade_projection.c

@@ -91,7 +91,7 @@ void pop_print(const SpringPipeline *pipeline)
     {
         SpringErrno ret;
 
-        SpringRow *row = spring_pop(pipeline, "q_sink_trade");
+        SpringSinkRow *row = spring_pop(pipeline, "q_sink_trade");
         assert_not_null(row);
 
         int r = spring_column_text(row, 0, (char *)ts, TS_LEN);
@@ -103,7 +103,7 @@ void pop_print(const SpringPipeline *pipeline)
 
         printf("[row#%d] ts=%s amount=%d\n", i, ts, amount);
 
-        spring_row_close(row);
+        spring_sink_row_close(row);
     }
 }
 

springql.h

@@ -50,9 +50,14 @@ typedef void *SpringConfig;
 typedef void *SpringPipeline;
 
 /**
- * Row object from an in memory queue.
+ * Row object to pop from an in memory queue.
  */
-typedef void *SpringRow;
+typedef void *SpringSinkRow;
+
+/**
+ * Row object to push into an in memory queue.
+ */
+typedef void *SpringSourceRow;
 
 /**
  * Returns default configuration.
@@ -146,7 +151,7 @@ enum SpringErrno spring_command(const SpringPipeline *pipeline, const char *sql)
  *
  * - `Unavailable`: queue named `queue` does not exist.
  */
-SpringRow *spring_pop(const SpringPipeline *pipeline, const char *queue);
+SpringSinkRow *spring_pop(const SpringPipeline *pipeline, const char *queue);
 
 /**
  * Pop a row from an in memory queue. This is a non-blocking function.
@@ -160,19 +165,55 @@ SpringRow *spring_pop(const SpringPipeline *pipeline, const char *queue);
  *
  * - `Unavailable`: queue named `queue` does not exist.
  */
-SpringRow *spring_pop_non_blocking(const SpringPipeline *pipeline,
-                                   const char *queue,
-                                   bool *is_err);
+SpringSinkRow *spring_pop_non_blocking(const SpringPipeline *pipeline,
+                                       const char *queue,
+                                       bool *is_err);
+
+/**
+ * Push a row into an in memory queue. This is a non-blocking function.
+ *
+ * # Returns
+ *
+ * - `Ok`: on success.
+ * - `Unavailable`: queue named `queue` does not exist.
+ */
+enum SpringErrno spring_push(const SpringPipeline *pipeline,
+                             const char *queue,
+                             const SpringSourceRow *row);
+
+/**
+ * Create a source row from JSON string
+ *
+ * # Returns
+ *
+ * - non-NULL: Successfully created a row.
+ * - NULL: Error occurred.
+ *
+ * # Errors
+ *
+ * - `InvalidFormat`: JSON string is invalid.
+ */
+SpringSourceRow *spring_source_row_from_json(const char *json);
+
+/**
+ * Frees heap occupied by a `SpringSourceRow`.
+ *
+ * # Returns
+ *
+ * - `Ok`: on success.
+ * - `CNull`: `pipeline` is a NULL pointer.
+ */
+enum SpringErrno spring_source_row_close(SpringSourceRow *row);
 
 /**
- * Frees heap occupied by a `SpringRow`.
+ * Frees heap occupied by a `SpringSinkRow`.
  *
  * # Returns
  *
  * - `Ok`: on success.
  * - `CNull`: `pipeline` is a NULL pointer.
  */
-enum SpringErrno spring_row_close(SpringRow *row);
+enum SpringErrno spring_sink_row_close(SpringSinkRow *row);
 
 /**
  * Get a 2-byte integer column.
@@ -191,7 +232,7 @@ enum SpringErrno spring_row_close(SpringRow *row);
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-enum SpringErrno spring_column_short(const SpringRow *row, uint16_t i_col, short *out);
+enum SpringErrno spring_column_short(const SpringSinkRow *row, uint16_t i_col, short *out);
 
 /**
  * Get a 4-byte integer column.
@@ -210,7 +251,7 @@ enum SpringErrno spring_column_short(const SpringRow *row, uint16_t i_col, short
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-enum SpringErrno spring_column_int(const SpringRow *row, uint16_t i_col, int *out);
+enum SpringErrno spring_column_int(const SpringSinkRow *row, uint16_t i_col, int *out);
 
 /**
  * Get an 8-byte integer column.
@@ -229,7 +270,7 @@ enum SpringErrno spring_column_int(const SpringRow *row, uint16_t i_col, int *ou
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-enum SpringErrno spring_column_long(const SpringRow *row, uint16_t i_col, long *out);
+enum SpringErrno spring_column_long(const SpringSinkRow *row, uint16_t i_col, long *out);
 
 /**
  * Get a 4-byte unsigned integer column.
@@ -248,7 +289,7 @@ enum SpringErrno spring_column_long(const SpringRow *row, uint16_t i_col, long *
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-enum SpringErrno spring_column_unsigned_int(const SpringRow *row,
+enum SpringErrno spring_column_unsigned_int(const SpringSinkRow *row,
                                             uint16_t i_col,
                                             unsigned int *out);
 
@@ -270,7 +311,7 @@ enum SpringErrno spring_column_unsigned_int(const SpringRow *row,
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-int spring_column_text(const SpringRow *row, uint16_t i_col, char *out, int out_len);
+int spring_column_text(const SpringSinkRow *row, uint16_t i_col, char *out, int out_len);
 
 /**
  * Get a BLOB column.
@@ -290,7 +331,7 @@ int spring_column_text(const SpringRow *row, uint16_t i_col, char *out, int out_
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-int spring_column_blob(const SpringRow *row, uint16_t i_col, void *out, int out_len);
+int spring_column_blob(const SpringSinkRow *row, uint16_t i_col, void *out, int out_len);
 
 /**
  * Get a bool column.
@@ -309,7 +350,7 @@ int spring_column_blob(const SpringRow *row, uint16_t i_col, void *out, int out_
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-enum SpringErrno spring_column_bool(const SpringRow *row, uint16_t i_col, bool *out);
+enum SpringErrno spring_column_bool(const SpringSinkRow *row, uint16_t i_col, bool *out);
 
 /**
  * Get a 4-byte floating point column.
@@ -328,7 +369,7 @@ enum SpringErrno spring_column_bool(const SpringRow *row, uint16_t i_col, bool *
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-enum SpringErrno spring_column_float(const SpringRow *row, uint16_t i_col, float *out);
+enum SpringErrno spring_column_float(const SpringSinkRow *row, uint16_t i_col, float *out);
 
 /**
  * Write the most recent error number into `errno` and message into a caller-provided buffer as a UTF-8