getDocumentByCriteria 🆕

Returns Case Insensitive SQL `LIKE` statement for DB query

Throws `errorNoCriteriaProvided` if props are empty.
Throws `errorDocumentNotFound` if document with specified id does not exist.

Signature

MySQL

getDocumentByCriteria(session: MySQLSession, props: Partial<IDocument<S>>, join?: 'OR' | 'AND'): Promise<IDocument<S>>;

MySQLX

getDocumentByCriteria(session: MySQLXSession, props: Partial<IDocument<S>>, join?: 'OR' | 'AND'): Promise<IDocument<S>>;

Example

MySQL

// employeeRouter.{ts|js}
import { employeeController } from './employeeController';
import { EmployeeProps } from './schemas/employee';

const officeId = '<_id>';

await db.usingSession(async (session) => {
    const data = await employeeController.getDocumentByCriteria(session, { [EmployeeProps.officeId]: officeId });
    return data;
}, transacted);

MySQLX

// employeeRouter.{ts|js}
import { employeeController } from './employeeController';
import { EmployeeProps } from './schemas/employee';

const officeId = '<_id>';

await db.usingSession(async (session) => {
    const data = await employeeController.getDocumentByCriteria(session, { [EmployeeProps.officeId]: officeId });
    return data;
}, transacted);