waii-sdk-js - npm Package Compare versions

Comparing version 1.7.3 to 1.7.5

dist/clients/query/src/Query.d.ts

		@@ -57,2 +57,5 @@ import { SearchContext, TableName, Column, SchemaName } from "../../database/src/Database";
		current_schema?: SchemaName;
		session_parameters?: {
		[a: string]: any;
		};
		};
		@@ -97,2 +100,4 @@ type RunQueryResponse = {
		query_text: string;
		execution_time_ms?: number;
		compilation_time_ms?: number;
		};
		@@ -99,0 +104,0 @@ export declare let Query: {

package.json

		{
		"name": "waii-sdk-js",
		"version": "1.7.3",
		"version": "1.7.5",
		"description": "Typescript / Javascript SDK for the waii api. SQL generation and much more.",
		@@ -5,0 +5,0 @@ "main": "dist/src/waii-sdk.js",

README.md

		@@ -18,2 +18,3 @@ # WAII SDK Documentation for TypeScript and JavaScript
		- [Showing the difference between two queries](#diffing-a-query)
		- [Analyzing the performance of a query](#performance-query)
		3. [Semantic Context Module](#semantic-context-module)
		@@ -372,3 +373,27 @@ - [Modifying the Semantic Context](#modifying-the-semantic-context)

		### Analyzing the performance of a query <a name="performance-query"></a>

		This function allows you to get a summary of the runtime of a query as well as recommendations of how to make the query run faster.

		```typescript
		async function analyzePeformance(params: QueryPerformanceRequest, signal?: AbortSignal): Promise<QueryPerformanceResponse>;
		```

		#### Parameters:

		- `params` (required): An object containing the performance request parameters.

		- `query_id` (optional): The uuid of the query. Can be retrieved from a query submit call, snowflake's history, or the waii query history.

		- `signal` (optional): An AbortSignal object for aborting the request.

		#### Returns:

		- A Promise resolving to a `QueryPerformance` object containing the performance description details.
		The QueryPerfromanceResponse object contains the following fields:

		- `summary`: A string array summarizing the runtime of the query.
		- `recommendations`: An array of strings providing recommendations of how to improve the runtime.
		- `query_text`: The sql of the query.

		## Semantic Context Module <a name="semantic-context-module"></a>
		@@ -375,0 +400,0 @@

Improved metrics