Kpok Patagon Framework

SqlServerSchemaDiscoverer

Implements a ISchemaDiscoverer for Microsoft SQL Server.

Namespace:
KpokPatagon.Data.SqlServer.DatabaseSchema
Type:
Class
Public:
Yes
Protected:
No
Sealed:
Yes
Abstract:
No

Methods

ExistsSchema

Checks whether a schema exists within the catalog configured on the DatabaseApi.

Signature:
public Boolean ExistsSchema(schema)
Returns

true if the schema exists.

Parameters
Name Type Summary
schema Schema Schema to check.
Exceptions
Type Summary
ValidationException Thrown when the schema configuration is not valid for checking existence.
ArgumentNullException Thrown when schema is null.
SchemaManipulationException Thown when there is an error accesing schema information.

ExistsTable

Checks whether a table exists within the catalog configured on the DatabaseApi.

Signature:
public Boolean ExistsTable(schema, tableName)
Returns

true is the table exists.

Parameters
Name Type Summary
schema String The schema to which the table belongs to.
tableName String The name of the table to check.
Exceptions
Type Summary
SchemaManipulationException Thown when there is an error accesing schema information.
ArgumentNullOrEmptyException Thrown when schema is null or empty.
ArgumentNullOrEmptyException Thrown when tableName is null or empty.

ExistsTable

Checks whether a table exists within the catalog configured on the DatabaseApi.

Signature:
public Boolean ExistsTable(table)
Returns

true if the table exists.

Parameters
Name Type Summary
table Table Table to check.
Exceptions
Type Summary
ArgumentNullException Thrown when table is null.
SchemaManipulationException Thown when there is an error accesing schema information.

ExistsView

Checks whether a view exists within the catalog configured on the DatabaseApi.

Signature:
public Boolean ExistsView(schema, viewName)
Returns

true is the view exists.

Parameters
Name Type Summary
schema String The schema to which the view belongs to.
viewName String The name of the view to check.
Exceptions
Type Summary
ArgumentNullOrEmptyException Thrown when schema is null or empty.
ArgumentNullOrEmptyException Thrown when viewName is null or empty.
SchemaManipulationException Thown when there is an error accesing schema information.

ExistsView

Checks whether a view exists within the catalog configured on the DatabaseApi.

Signature:
public Boolean ExistsView(view)
Returns

true if the view exists.

Parameters
Name Type Summary
view Table View to check.
Exceptions
Type Summary
ArgumentNullException Thrown when view is null.
SchemaManipulationException Thown when there is an error accesing schema information.

GetCatalogs

Get a list of user created catalogs.

Signature:
public IList GetCatalogs()
Returns

A list of user catalogs.

Exceptions
Type Summary
SchemaManipulationException Thown when there is an error accesing schema information.

GetSchemas

Gets a list of user created schemas from the catalog configured on the DatabaseApi.

Signature:
public IList GetSchemas()
Returns

A list of user schemas.

Exceptions
Type Summary
SchemaManipulationException Thown when there is an error accesing schema information.

GetTable

Gets the schema of a table from the catalog configured on the DatabaseApi.

Signature:
public Table GetTable(schema, tableName)
Returns

A table definition.

Parameters
Name Type Summary
schema String Schema that the table belongs to.
tableName String The name of the table.
Exceptions
Type Summary
SchemaManipulationException Thown when there is an error accesing schema information.
TableOrViewNotFoundException Thrown when the specified table does not exists.
ArgumentNullOrEmptyException Thrown when schema or tableName are null or empty.

GetTable

Gets the schema of a table from the catalog configured on the DatabaseApi.

Signature:
public Table GetTable(tableName)
Returns

A table definition.

Parameters
Name Type Summary
tableName TableName Name of the table.
Exceptions
Type Summary
ArgumentNullException Thrown when tableName is null.
SchemaManipulationException Thown when there is an error accesing schema information.
TableOrViewNotFoundException Thrown when the specified table does not exists.

GetTableNames

Gets a list of table names from the catalog configured on the DatabaseApi.

Signature:
public IList GetTableNames()
Returns

A list of table names.

Exceptions
Type Summary
SchemaManipulationException Thown when there is an error accesing schema information.

GetTables

Gets a list of all tables from the catalog configured on the DatabaseApi.

Signature:
public IList GetTables()
Returns

A collection of tables.

Exceptions
Type Summary
SchemaManipulationException Thown when there is an error accesing schema information.

GetView

Gets the schema of a view from the catalog configured on the DatabaseApi.

Signature:
public Table GetView(schema, viewName)
Returns

A definition for the specified view.

Parameters
Name Type Summary
schema String Schema to which the view belongs to.
viewName String Name of the view.
Exceptions
Type Summary
SchemaManipulationException Thown when there is an error accesing schema information.
TableOrViewNotFoundException Thrown when the specified view does not exists.
ArgumentNullOrEmptyException Thrown when schema or viewName are null or empty.

GetView

Gets the schema of a view from the catalog configured on the DatabaseApi.

Signature:
public Table GetView(viewName)
Returns

A definition for the specified view.

Parameters
Name Type Summary
viewName TableName Name of the view.
Exceptions
Type Summary
ArgumentNullException Thrown when viewName is null.
SchemaManipulationException Thown when there is an error accesing schema information.
TableOrViewNotFoundException Thrown when the specified view does not exists.
ArgumentNullOrEmptyException Thrown when viewName.Schema.Schema or viewName.Name.Name are null or empty.

GetViewNames

Gets a list of view names from the catalog configured on the DatabaseApi.

Signature:
public IList GetViewNames()
Returns

A list of view names.

Exceptions
Type Summary
SchemaManipulationException Thown when there is an error accesing schema information.

GetViews

Gets a list of all views from the catalog configured on the DatabaseApi.

Signature:
public IList GetViews()
Returns

A collection of views.

Exceptions
Type Summary
SchemaManipulationException Thown when there is an error accesing schema information.
MissingRequiredPropertyException Thrown when a required property was not properly initialized.

In this document