flip/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/DefinitelyTyped.git synced 2026-02-06 10:56:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[mssql] Fix incorrect Table and Request interfaces (#37123)

Browse Source 
* [mssql] align bulk method signatures with implementation

* [mssql] add optional table path properties

These properties go alongside the optional tableName parameter as per [this part of the table script](6188de3a83/lib/table.js (L10-L17))

* [mssql] add optional temporary property to Table class
This commit is contained in:
Cahil Foley 2019-07-26 02:36:01 +08:00 committed by Wesley Wigham
parent 5fd76280b3
commit 3645f6c5db
1 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
types/mssql/index.d.ts vendored
View File

@ -136,6 +136,11 @@ export interface IResult<T> {
rowsAffected: number[],
output: { [key: string]: any };
}
export interface IBulkResult {
rowsAffected: number;
}
export interface IProcedureResult<T> extends IResult<T> {
returnValue: any;
}
@ -246,6 +251,11 @@ export declare class Table {
public columns: columns;
public rows: rows;
public constructor(tableName?: string);
public schema?: string;
public database?: string;
public name?: string;
public path?: string;
public temporary?: boolean;
}
interface IRequestParameters {
@ -261,6 +271,20 @@ interface IRequestParameters {
}
}
/**
* Options object to be passed through to driver (currently tedious only)
*/
export interface IBulkOptions {
/** Honors constraints during bulk load, using T-SQL CHECK_CONSTRAINTS. (default: false) */
checkConstraints?: boolean;
/** Honors insert triggers during bulk load, using the T-SQL FIRE_TRIGGERS. (default: false) */
fireTriggers?: boolean;
/** Honors null value passed, ignores the default values set on table, using T-SQL KEEP_NULLS. (default: false) */
keepNulls?: boolean;
/** Places a bulk update(BU) lock on table while performing bulk load, using T-SQL TABLOCK. (default: false) */
tableLock?: boolean;
}
export declare class Request extends events.EventEmitter {
public transaction: Transaction;
public pstatement: PreparedStatement;
@ -288,8 +312,10 @@ export declare class Request extends events.EventEmitter {
public batch<Entity>(batch: string): Promise<IResult<Entity>>;
public batch(batch: string, callback: (err?: Error, recordset?: IResult<any>) => void): void;
public batch<Entity>(batch: string, callback: (err?: any, recordset?: IResult<Entity>) => void): void;
public bulk(table: Table): Promise<number>;
public bulk(table: Table, callback: (err: Error, rowCount: any) => void): void;
public bulk(table: Table): Promise<IBulkResult>;
public bulk(table: Table, options: IBulkOptions): Promise<IBulkResult>;
public bulk(table: Table, callback: (err: Error, result: IBulkResult) => void): void;
public bulk(table: Table, options: IBulkOptions, callback: (err: Error, result: IBulkResult) => void): void;
public cancel(): void;
public pause(): boolean;
public resume(): boolean;