36 lines
1.6 KiB
TypeScript
36 lines
1.6 KiB
TypeScript
|
export = updateDbEntry;
|
||
|
|
/**
|
||
|
|
* Update DB Function
|
||
|
|
* ==============================================================================
|
||
|
|
* @description Description
|
||
|
|
* @async
|
||
|
|
*
|
||
|
|
* @param {object} params - An object containing the function parameters.
|
||
|
|
* @param {("Master" | "Dsql User")} [params.dbContext] - What is the database context? "Master"
|
||
|
|
* or "Dsql User". Defaults to "Master"
|
||
|
|
* @param {("Read Only" | "Full Access")} [params.paradigm] - What is the paradigm for "Dsql User"?
|
||
|
|
* "Read only" or "Full Access"? Defaults to "Read Only"
|
||
|
|
* @param {string} [params.dbFullName] - Database full name
|
||
|
|
* @param {string} params.tableName - Table name
|
||
|
|
* @param {string} [params.encryptionKey]
|
||
|
|
* @param {string} [params.encryptionSalt]
|
||
|
|
* @param {any} params.data - Data to add
|
||
|
|
* @param {import("../../../types").DSQL_TableSchemaType} [params.tableSchema] - Table schema
|
||
|
|
* @param {string} params.identifierColumnName - Update row identifier column name
|
||
|
|
* @param {string | number} params.identifierValue - Update row identifier column value
|
||
|
|
*
|
||
|
|
* @returns {Promise<object|null>}
|
||
|
|
*/
|
||
|
|
declare function updateDbEntry({ dbContext, paradigm, dbFullName, tableName, data, tableSchema, identifierColumnName, identifierValue, encryptionKey, encryptionSalt, }: {
|
||
|
|
dbContext?: ("Master" | "Dsql User");
|
||
|
|
paradigm?: ("Read Only" | "Full Access");
|
||
|
|
dbFullName?: string;
|
||
|
|
tableName: string;
|
||
|
|
encryptionKey?: string;
|
||
|
|
encryptionSalt?: string;
|
||
|
|
data: any;
|
||
|
|
tableSchema?: import("../../../types").DSQL_TableSchemaType;
|
||
|
|
identifierColumnName: string;
|
||
|
|
identifierValue: string | number;
|
||
|
|
}): Promise<object | null>;
|