node-firebird-driver-native 3.2.2 → 3.3.0

package/src/lib/fb-util.ts

@@ -3,82 +3,82 @@ export * from 'node-firebird-driver/dist/lib/impl';
 
 import * as fb from 'node-firebird-native-api';
 
-
 /** Fix metadata descriptors to types we want to read. */
 export function fixMetadata(status: fb.Status, metadata?: fb.MessageMetadata): fb.MessageMetadata | undefined {
-	if (!metadata)
-		return undefined;
-
-	let ret: fb.MessageMetadata;
-
-	const outBuilder = metadata.getBuilderSync(status)!;
-	try {
-		for (let i = metadata.getCountSync(status) - 1; i >= 0; --i) {
-			switch (metadata.getTypeSync(status, i)) {
-				// Transform CHAR descriptors to VARCHAR.
-				case sqlTypes.SQL_TEXT:
-					outBuilder.setTypeSync(status, i, sqlTypes.SQL_VARYING);
-					break;
-
-				// Transform numeric descriptors to DOUBLE PRECISION.
-				case sqlTypes.SQL_SHORT:
-				case sqlTypes.SQL_LONG:
-				case sqlTypes.SQL_INT64:
-				case sqlTypes.SQL_FLOAT:
-					outBuilder.setTypeSync(status, i, sqlTypes.SQL_DOUBLE);
-					outBuilder.setLengthSync(status, i, 8);
-					outBuilder.setScaleSync(status, i, 0);
-					break;
-
-				// Transform TIME_TZ to TIME_TZ_EX.
-				case sqlTypes.SQL_TIME_TZ:
-					outBuilder.setTypeSync(status, i, sqlTypes.SQL_TIME_TZ_EX);
-					break;
-
-				// Transform TIMESTAMP_TZ to TIMESTAMP_TZ_EX.
-				case sqlTypes.SQL_TIMESTAMP_TZ:
-					outBuilder.setTypeSync(status, i, sqlTypes.SQL_TIMESTAMP_TZ_EX);
-					break;
-
-				// Transform INT128, DEC16 and DEC34 descriptors to VARCHAR.
-				case sqlTypes.SQL_INT128:
-				case sqlTypes.SQL_DEC16:
-				case sqlTypes.SQL_DEC34:
-					outBuilder.setTypeSync(status, i, sqlTypes.SQL_VARYING);
-					outBuilder.setLengthSync(status, i, 45);
-					outBuilder.setCharSetSync(status, i, charSets.ascii);
-					break;
-			}
-		}
-
-		ret = outBuilder.getMetadataSync(status)!;
-	}
-	finally {
-		outBuilder.releaseSync();
-	}
-
-	metadata.releaseSync();
-
-	return ret;
+  if (!metadata) {
+    return undefined;
+  }
+
+  let ret: fb.MessageMetadata;
+
+  const outBuilder = metadata.getBuilderSync(status)!;
+  try {
+    for (let i = metadata.getCountSync(status) - 1; i >= 0; --i) {
+      switch (metadata.getTypeSync(status, i)) {
+        // Transform CHAR descriptors to VARCHAR.
+        case sqlTypes.SQL_TEXT:
+          outBuilder.setTypeSync(status, i, sqlTypes.SQL_VARYING);
+          break;
+
+        // Transform numeric descriptors to DOUBLE PRECISION.
+        case sqlTypes.SQL_SHORT:
+        case sqlTypes.SQL_LONG:
+        case sqlTypes.SQL_INT64:
+        case sqlTypes.SQL_FLOAT:
+          outBuilder.setTypeSync(status, i, sqlTypes.SQL_DOUBLE);
+          outBuilder.setLengthSync(status, i, 8);
+          outBuilder.setScaleSync(status, i, 0);
+          break;
+
+        // Transform TIME_TZ to TIME_TZ_EX.
+        case sqlTypes.SQL_TIME_TZ:
+          outBuilder.setTypeSync(status, i, sqlTypes.SQL_TIME_TZ_EX);
+          break;
+
+        // Transform TIMESTAMP_TZ to TIMESTAMP_TZ_EX.
+        case sqlTypes.SQL_TIMESTAMP_TZ:
+          outBuilder.setTypeSync(status, i, sqlTypes.SQL_TIMESTAMP_TZ_EX);
+          break;
+
+        // Transform INT128, DEC16 and DEC34 descriptors to VARCHAR.
+        case sqlTypes.SQL_INT128:
+        case sqlTypes.SQL_DEC16:
+        case sqlTypes.SQL_DEC34:
+          outBuilder.setTypeSync(status, i, sqlTypes.SQL_VARYING);
+          outBuilder.setLengthSync(status, i, 45);
+          outBuilder.setCharSetSync(status, i, charSets.ascii);
+          break;
+      }
+    }
+
+    ret = outBuilder.getMetadataSync(status)!;
+  } finally {
+    outBuilder.releaseSync();
+  }
+
+  metadata.releaseSync();
+
+  return ret;
 }
 
 export function createDescriptors(status: fb.Status, metadata?: fb.MessageMetadata): Descriptor[] {
-	if (!metadata)
-		return [];
-
-	const count = metadata.getCountSync(status);
-	const ret: Descriptor[] = [];
-
-	for (let i = 0; i < count; ++i) {
-		ret.push({
-			type: metadata.getTypeSync(status, i),
-			subType: metadata.getSubTypeSync(status, i),
-			nullOffset: metadata.getNullOffsetSync(status, i),
-			offset: metadata.getOffsetSync(status, i),
-			length: metadata.getLengthSync(status, i),
-			scale: metadata.getScaleSync(status, i)
-		});
-	}
-
-	return ret;
+  if (!metadata) {
+    return [];
+  }
+
+  const count = metadata.getCountSync(status);
+  const ret: Descriptor[] = [];
+
+  for (let i = 0; i < count; ++i) {
+    ret.push({
+      type: metadata.getTypeSync(status, i),
+      subType: metadata.getSubTypeSync(status, i),
+      nullOffset: metadata.getNullOffsetSync(status, i),
+      offset: metadata.getOffsetSync(status, i),
+      length: metadata.getLengthSync(status, i),
+      scale: metadata.getScaleSync(status, i),
+    });
+  }
+
+  return ret;
 }

package/src/lib/resultset.ts

@@ -6,88 +6,100 @@ import { AbstractResultSet } from 'node-firebird-driver/dist/lib/impl';
 
 import * as fb from 'node-firebird-native-api';
 
-
 /** ResultSet implementation. */
 export class ResultSetImpl extends AbstractResultSet {
-	// Override declarations.
-	override statement: StatementImpl;
-	override transaction: TransactionImpl;
-
-	resultSetHandle?: fb.ResultSet;
-	delayedError: any;
-
-	static async open(statement: StatementImpl, transaction: TransactionImpl, parameters?: Array<any>,
-			options?: ExecuteQueryOptions): Promise<ResultSetImpl> {
-		const resultSet = new ResultSetImpl(statement, transaction);
-
-		return await statement.attachment.client.statusAction(async status => {
-			//// FIXME: options
-
-			await statement.dataWriter(statement.attachment, transaction, statement.inBuffer, parameters);
-
-			resultSet.resultSetHandle = await statement.statementHandle!.openCursorAsync(status, transaction.transactionHandle,
-				statement.inMetadata, statement.inBuffer, statement.outMetadata, 0);
-
-			return resultSet;
-		});
-	}
-
-	/** Closes this result set. */
-	protected async internalClose(): Promise<void> {
-		await this.statement.attachment.client.statusAction(async status => {
-			await this.resultSetHandle!.closeAsync(status);
-
-			this.resultSetHandle = undefined;
-		});
-	}
-
-	/** Fetchs data from this result set. */
-	protected async internalFetch(options?: FetchOptions): Promise<{ finished: boolean; rows: any[][] }> {
-		return await this.statement.attachment.client.statusAction(async status => {
-			if (this.delayedError) {
-				const error = this.delayedError;
-				this.delayedError = undefined;
-				throw error;
-			}
-
-			const rows = [];
-			const buffers = [this.statement.outBuffer, new Uint8Array(this.statement.outMetadata!.getMessageLengthSync(status))];
-			let buffer = 0;
-			let nextFetchPromise = this.resultSetHandle!.fetchNextAsync(status, buffers[buffer]);
-
-			while (true) {
-				let nextFetch: number;
-
-				try {
-					nextFetch = await nextFetchPromise;
-				}
-				catch (e) {
-					if (rows.length == 0)
-						throw e;
-					else {
-						this.delayedError = e;
-						return { finished: false, rows };
-					}
-				}
-
-				if (nextFetch == fb.Status.RESULT_OK) {
-					const buffer1 = buffer;
-					buffer = ++buffer % 2;
-
-					const finish = options && options.fetchSize && rows.length + 1 >= options.fetchSize;
-
-					if (!finish)
-						nextFetchPromise = this.resultSetHandle!.fetchNextAsync(status, buffers[buffer]);
-
-					rows.push(await this.statement.dataReader(this.statement.attachment, this.transaction, buffers[buffer1]));
-
-					if (finish)
-						return { finished: false, rows };
-				}
-				else {
-					return { finished: true, rows };
-				}
-			}
-		});
-	}
+  // Override declarations.
+  override statement: StatementImpl;
+  override transaction: TransactionImpl;
+
+  resultSetHandle?: fb.ResultSet;
+  delayedError: any;
+
+  static async open(
+    statement: StatementImpl,
+    transaction: TransactionImpl,
+    parameters?: any[],
+    _options?: ExecuteQueryOptions,
+  ): Promise<ResultSetImpl> {
+    const resultSet = new ResultSetImpl(statement, transaction);
+
+    return await statement.attachment.client.statusAction(async (status) => {
+      //// FIXME: options
+
+      await statement.dataWriter(statement.attachment, transaction, statement.inBuffer, parameters);
+
+      resultSet.resultSetHandle = await statement.statementHandle!.openCursorAsync(
+        status,
+        transaction.transactionHandle,
+        statement.inMetadata,
+        statement.inBuffer,
+        statement.outMetadata,
+        0,
+      );
+
+      return resultSet;
+    });
+  }
+
+  /** Closes this result set. */
+  protected async internalClose(): Promise<void> {
+    await this.statement.attachment.client.statusAction(async (status) => {
+      await this.resultSetHandle!.closeAsync(status);
+
+      this.resultSetHandle = undefined;
+    });
+  }
+
+  /** Fetchs data from this result set. */
+  protected async internalFetch(options?: FetchOptions): Promise<{ finished: boolean; rows: any[][] }> {
+    return await this.statement.attachment.client.statusAction(async (status) => {
+      if (this.delayedError) {
+        const error = this.delayedError;
+        this.delayedError = undefined;
+        throw error;
+      }
+
+      const rows = [];
+      const buffers = [
+        this.statement.outBuffer,
+        new Uint8Array(this.statement.outMetadata!.getMessageLengthSync(status)),
+      ];
+      let buffer = 0;
+      let nextFetchPromise = this.resultSetHandle!.fetchNextAsync(status, buffers[buffer]);
+
+      while (true) {
+        let nextFetch: number;
+
+        try {
+          nextFetch = await nextFetchPromise;
+        } catch (e) {
+          if (rows.length == 0) {
+            throw e;
+          } else {
+            this.delayedError = e;
+            return { finished: false, rows };
+          }
+        }
+
+        if (nextFetch == fb.Status.RESULT_OK) {
+          const buffer1 = buffer;
+          buffer = ++buffer % 2;
+
+          const finish = options && options.fetchSize && rows.length + 1 >= options.fetchSize;
+
+          if (!finish) {
+            nextFetchPromise = this.resultSetHandle!.fetchNextAsync(status, buffers[buffer]);
+          }
+
+          rows.push(await this.statement.dataReader(this.statement.attachment, this.transaction, buffers[buffer1]));
+
+          if (finish) {
+            return { finished: false, rows };
+          }
+        } else {
+          return { finished: true, rows };
+        }
+      }
+    });
+  }
 }

package/src/lib/statement.ts

@@ -2,155 +2,169 @@ import { AttachmentImpl } from './attachment';
 import { ResultSetImpl } from './resultset';
 import { TransactionImpl } from './transaction';
 
-import {
-	ExecuteOptions,
-	ExecuteQueryOptions,
-	PrepareOptions
-} from 'node-firebird-driver';
+import { ExecuteOptions, ExecuteQueryOptions, PrepareOptions } from 'node-firebird-driver';
 
 import { AbstractStatement, commonInfo, getPortableInteger, statementInfo } from 'node-firebird-driver/dist/lib/impl';
 
-import {
-	createDataReader,
-	createDataWriter,
-	createDescriptors,
-	fixMetadata,
-	DataReader,
-	DataWriter
-} from './fb-util';
+import { createDataReader, createDataWriter, createDescriptors, fixMetadata, DataReader, DataWriter } from './fb-util';
 
 import * as fb from 'node-firebird-native-api';
 
 import { TextDecoder } from 'util';
 
-
 /** Statement implementation. */
 export class StatementImpl extends AbstractStatement {
-	// Override declarations.
-	override attachment: AttachmentImpl;
-	override hasResultSet: boolean;
-
-	statementHandle?: fb.Statement;
-	inMetadata?: fb.MessageMetadata;
-	outMetadata?: fb.MessageMetadata;
-	inBuffer: Uint8Array;
-	outBuffer: Uint8Array;
-	dataWriter: DataWriter;
-	dataReader: DataReader;
-
-	static async prepare(attachment: AttachmentImpl, transaction: TransactionImpl, sqlStmt: string, options?: PrepareOptions):
-			Promise<StatementImpl> {
-		const statement = new StatementImpl(attachment);
-
-		return await attachment.client.statusAction(async status => {
-			//// FIXME: options/flags, dialect
-			statement.statementHandle = await attachment!.attachmentHandle!.prepareAsync(status, transaction?.transactionHandle,
-				0, sqlStmt, 3, fb.Statement.PREPARE_PREFETCH_ALL);
-
-			statement.hasResultSet = (statement.statementHandle!.getFlagsSync(status) & fb.Statement.FLAG_HAS_CURSOR) != 0;
-
-			statement.inMetadata = fixMetadata(status, await statement.statementHandle!.getInputMetadataAsync(status));
-			statement.outMetadata = fixMetadata(status, await statement.statementHandle!.getOutputMetadataAsync(status));
-
-			if (statement.inMetadata) {
-				statement.inBuffer = new Uint8Array(statement.inMetadata.getMessageLengthSync(status));
-				statement.dataWriter = createDataWriter(createDescriptors(status, statement.inMetadata));
-			}
-
-			if (statement.outMetadata) {
-				statement.outBuffer = new Uint8Array(statement.outMetadata.getMessageLengthSync(status));
-				statement.dataReader = createDataReader(createDescriptors(status, statement.outMetadata));
-			}
-
-			return statement;
-		});
-	}
-
-	/** Disposes this statement's resources. */
-	protected async internalDispose(): Promise<void> {
-		if (this.outMetadata) {
-			this.outMetadata.releaseSync();
-			this.outMetadata = undefined;
-		}
-
-		if (this.inMetadata) {
-			this.inMetadata.releaseSync();
-			this.inMetadata = undefined;
-		}
-
-		await this.attachment.client.statusAction(status => this.statementHandle!.freeAsync(status));
-
-		this.statementHandle = undefined;
-	}
-
-	/** Executes a prepared statement that uses the SET TRANSACTION command. Returns the new transaction. */
-	protected async internalExecuteTransaction(transaction: TransactionImpl): Promise<TransactionImpl> {
-		throw new Error('Uninplemented method: executeTransaction.');
-	}
-
-	/** Executes a prepared statement that has no result set. */
-	protected async internalExecute(transaction: TransactionImpl, parameters?: Array<any>, options?: ExecuteOptions): Promise<Array<any>> {
-		return await this.attachment.client.statusAction(async status => {
-			await this.dataWriter(this.attachment, transaction, this.inBuffer, parameters);
-
-			const newTransaction = await this.statementHandle!.executeAsync(status, transaction?.transactionHandle,
-				this.inMetadata, this.inBuffer, this.outMetadata, this.outBuffer);
-
-			if (newTransaction && transaction?.transactionHandle != newTransaction) {
-				//// FIXME: newTransaction.releaseSync();
-			}
-
-			return this.outMetadata ? await this.dataReader(this.attachment, transaction, this.outBuffer) : [];
-		});
-	}
-
-	/** Executes a prepared statement that has result set. */
-	protected async internalExecuteQuery(transaction: TransactionImpl, parameters?: Array<any>, options?: ExecuteQueryOptions):
-			Promise<ResultSetImpl> {
-		return await ResultSetImpl.open(this, transaction as TransactionImpl, parameters, options);
-	}
-
-	async setCursorName(cursorName: string): Promise<void> {
-		return await this.attachment.client.statusAction(async status =>
-			await this.statementHandle!.setCursorNameAsync(status, cursorName)
-		);
-	}
-
-	async getExecPathText(): Promise<string | undefined> {
-		return await this.attachment.client.statusAction(async status => {
-			const infoReq = new Uint8Array([statementInfo.sqlExecPathBlrText]);
-			const infoRet = new Uint8Array(65535);
-			await this.statementHandle!.getInfoAsync(status, infoReq.byteLength, infoReq, infoRet.byteLength, infoRet);
-
-			if (infoRet[0] == commonInfo.end)
-				return undefined;
-			else {
-				if (infoRet[0] != statementInfo.sqlExecPathBlrText)
-					throw new Error('Error retrieving statement execution path.');
-
-				const size = getPortableInteger(infoRet.subarray(1), 2);
-				return new TextDecoder().decode(infoRet.subarray(3, 3 + size));
-			}
-		});
-	}
-
-	get columnLabels(): Promise<string[]> {
-		const asyncFunc = async (): Promise<string[]> => {
-			if (!this.outMetadata)
-				return [];
-
-			return await this.attachment.client.statusAction(async status => {
-				const metaData = this.outMetadata!;
-				const count = metaData.getCountSync(status);
-				const array: string[] = [];
-
-				for (let i = 0; i < count; ++i)
-					array.push(metaData.getAliasSync(status, i)!);
-
-				return array;
-			});
-		};
-
-		return asyncFunc();
-	}
+  // Override declarations.
+  override attachment: AttachmentImpl;
+  override hasResultSet: boolean;
+
+  statementHandle?: fb.Statement;
+  inMetadata?: fb.MessageMetadata;
+  outMetadata?: fb.MessageMetadata;
+  inBuffer: Uint8Array;
+  outBuffer: Uint8Array;
+  dataWriter: DataWriter;
+  dataReader: DataReader;
+
+  static async prepare(
+    attachment: AttachmentImpl,
+    transaction: TransactionImpl,
+    sqlStmt: string,
+    _options?: PrepareOptions,
+  ): Promise<StatementImpl> {
+    const statement = new StatementImpl(attachment);
+
+    return await attachment.client.statusAction(async (status) => {
+      //// FIXME: options/flags, dialect
+      statement.statementHandle = await attachment!.attachmentHandle!.prepareAsync(
+        status,
+        transaction?.transactionHandle,
+        0,
+        sqlStmt,
+        3,
+        fb.Statement.PREPARE_PREFETCH_ALL,
+      );
+
+      statement.hasResultSet = (statement.statementHandle!.getFlagsSync(status) & fb.Statement.FLAG_HAS_CURSOR) != 0;
+
+      statement.inMetadata = fixMetadata(status, await statement.statementHandle!.getInputMetadataAsync(status));
+      statement.outMetadata = fixMetadata(status, await statement.statementHandle!.getOutputMetadataAsync(status));
+
+      if (statement.inMetadata) {
+        statement.inBuffer = new Uint8Array(statement.inMetadata.getMessageLengthSync(status));
+        statement.dataWriter = createDataWriter(createDescriptors(status, statement.inMetadata));
+      }
+
+      if (statement.outMetadata) {
+        statement.outBuffer = new Uint8Array(statement.outMetadata.getMessageLengthSync(status));
+        statement.dataReader = createDataReader(createDescriptors(status, statement.outMetadata));
+      }
+
+      return statement;
+    });
+  }
+
+  /** Disposes this statement's resources. */
+  protected async internalDispose(): Promise<void> {
+    if (this.outMetadata) {
+      this.outMetadata.releaseSync();
+      this.outMetadata = undefined;
+    }
+
+    if (this.inMetadata) {
+      this.inMetadata.releaseSync();
+      this.inMetadata = undefined;
+    }
+
+    await this.attachment.client.statusAction((status) => this.statementHandle!.freeAsync(status));
+
+    this.statementHandle = undefined;
+  }
+
+  /** Executes a prepared statement that uses the SET TRANSACTION command. Returns the new transaction. */
+  protected async internalExecuteTransaction(_transaction: TransactionImpl): Promise<TransactionImpl> {
+    throw new Error('Uninplemented method: executeTransaction.');
+  }
+
+  /** Executes a prepared statement that has no result set. */
+  protected async internalExecute(
+    transaction: TransactionImpl,
+    parameters?: any[],
+    _options?: ExecuteOptions,
+  ): Promise<any[]> {
+    return await this.attachment.client.statusAction(async (status) => {
+      await this.dataWriter(this.attachment, transaction, this.inBuffer, parameters);
+
+      const newTransaction = await this.statementHandle!.executeAsync(
+        status,
+        transaction?.transactionHandle,
+        this.inMetadata,
+        this.inBuffer,
+        this.outMetadata,
+        this.outBuffer,
+      );
+
+      if (newTransaction && transaction?.transactionHandle != newTransaction) {
+        //// FIXME: newTransaction.releaseSync();
+      }
+
+      return this.outMetadata ? await this.dataReader(this.attachment, transaction, this.outBuffer) : [];
+    });
+  }
+
+  /** Executes a prepared statement that has result set. */
+  protected async internalExecuteQuery(
+    transaction: TransactionImpl,
+    parameters?: any[],
+    options?: ExecuteQueryOptions,
+  ): Promise<ResultSetImpl> {
+    return await ResultSetImpl.open(this, transaction as TransactionImpl, parameters, options);
+  }
+
+  async setCursorName(cursorName: string): Promise<void> {
+    return await this.attachment.client.statusAction(
+      async (status) => await this.statementHandle!.setCursorNameAsync(status, cursorName),
+    );
+  }
+
+  async getExecPathText(): Promise<string | undefined> {
+    return await this.attachment.client.statusAction(async (status) => {
+      const infoReq = new Uint8Array([statementInfo.sqlExecPathBlrText]);
+      const infoRet = new Uint8Array(65535);
+      await this.statementHandle!.getInfoAsync(status, infoReq.byteLength, infoReq, infoRet.byteLength, infoRet);
+
+      if (infoRet[0] == commonInfo.end) {
+        return undefined;
+      } else {
+        if (infoRet[0] != statementInfo.sqlExecPathBlrText) {
+          throw new Error('Error retrieving statement execution path.');
+        }
+
+        const size = getPortableInteger(infoRet.subarray(1), 2);
+        return new TextDecoder().decode(infoRet.subarray(3, 3 + size));
+      }
+    });
+  }
+
+  get columnLabels(): Promise<string[]> {
+    const asyncFunc = async (): Promise<string[]> => {
+      if (!this.outMetadata) {
+        return [];
+      }
+
+      return await this.attachment.client.statusAction(async (status) => {
+        const metaData = this.outMetadata!;
+        const count = metaData.getCountSync(status);
+        const array: string[] = [];
+
+        for (let i = 0; i < count; ++i) {
+          array.push(metaData.getAliasSync(status, i)!);
+        }
+
+        return array;
+      });
+    };
+
+    return asyncFunc();
+  }
 }