Skip to content
# Class: SqlSchemaValidator

Defined in: packages/core/src/utils/SqlSchemaValidator.ts:20

Validates SQL query structures against known tables and columns.

Example ​

typescript
const tables = [
  { name: 'users', columns: ['id', 'email'] }
];

SqlSchemaValidator.validate('SELECT id FROM users', tables);

Related tests: packages/core/tests/utils/SqlSchemaValidator.validate.test.ts

Constructors ​

Constructor ​

new SqlSchemaValidator(): SqlSchemaValidator

Returns ​

SqlSchemaValidator

Methods ​

validate() ​

static validate(sql, tableResolver): void

Defined in: packages/core/src/utils/SqlSchemaValidator.ts:27

Validates a SQL query structure against a provided TableColumnResolver or TableSchema array.

Parameters ​

sql ​

The SQL query structure to validate, can be a SQL string or a SqlComponent.

string | SqlComponent

tableResolver ​

The TableColumnResolver or TableSchema array to validate against.

TableColumnResolver | TableSchema[]

Returns ​

void

Throws ​

Error if the query contains undefined tables or columns.

Released under the MIT License.