ironflock 1.2.9 → 1.3.2

package/dist/index.d.ts

@@ -14,6 +14,12 @@ export declare type AuthPayload = {
     };
 };
 
+export declare interface BulkTableParams {
+    tablename: string & tags.MinLength<1>;
+    rows: Record<string, unknown>[] & tags.MinItems<1>;
+    kwargs?: Record<string, unknown>;
+}
+
 export declare interface CallParams {
     deviceKey: string & tags.MinLength<1>;
     topic: string & tags.MinLength<1>;
@@ -85,6 +91,24 @@ export declare class IronFlock {
     publish(topic: string, args?: unknown[], kwargs?: Record<string, unknown>): Promise<unknown>;
     publishToTable(tablename: string, args?: unknown[], kwargs?: Record<string, unknown>): Promise<unknown>;
     appendToTable(tablename: string, args?: unknown[], kwargs?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Publishes many rows in a single message (bulk insert) to the dedicated topic
+     * `bulk.{swarmKey}.{appKey}.{tablename}`. The platform inserts the whole batch
+     * atomically (all-or-nothing). Use for high-frequency data where one round-trip
+     * per row is too costly. Like publishToTable this is fire-and-forget — the ack
+     * confirms delivery to the router, not the DB insert. Use appendRowsToTable when
+     * you need the insert outcome.
+     */
+    publishRowsToTable(tablename: string, rows: Record<string, unknown>[], kwargs?: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Appends many rows in a single RPC (bulk insert) by calling the dedicated
+     * procedure `appendBulk.{swarmKey}.{appKey}.{tablename}`. The platform inserts
+     * the whole batch atomically (all-or-nothing): if any row is invalid the entire
+     * batch is rejected and nothing is persisted. Resolves with the RPC result
+     * (e.g. { success: true, count: N }). Prefer over publishRowsToTable when you
+     * need the insert outcome.
+     */
+    appendRowsToTable(tablename: string, rows: Record<string, unknown>[], kwargs?: Record<string, unknown>): Promise<unknown>;
     subscribe(topic: string, handler: (...args: any[]) => void, options?: object): Promise<default_2.Subscription<any[], any, string> | undefined>;
     subscribeToTable(tablename: string, handler: (...args: any[]) => void, options?: object): Promise<default_2.Subscription<any[], any, string> | undefined>;
     call(topic: string, args?: unknown[], kwargs?: Record<string, unknown>, options?: object): Promise<unknown>;
@@ -167,6 +191,8 @@ export declare interface TableQueryParams {
     filterAnd?: SQLFilterAnd[];
 }
 
+export declare const validateBulkTableParams: ((input: unknown) => default_3.IValidation<BulkTableParams>) & StandardSchemaV1<BulkTableParams, BulkTableParams>;
+
 export declare const validateCallParams: ((input: unknown) => default_3.IValidation<CallParams>) & StandardSchemaV1<CallParams, CallParams>;
 
 export declare const validateLocationParams: ((input: unknown) => default_3.IValidation<LocationParams>) & StandardSchemaV1<LocationParams, LocationParams>;