Show / Hide Table of Contents

Interface ISchemaProvider

Provides an interface to retrieve schema information from the database.

Namespace: Paradigm.ORM.Data.Database.Schema
Assembly: Paradigm.ORM.Data.dll
Syntax
public interface ISchemaProvider : IDisposable

Methods

| Improve this Doc View Source

GetColumns(String, String)

Gets the schema of all the columns of a table.

Declaration
List<IColumn> GetColumns(string database, string tableName)
Parameters
Type Name Description
System.String database

The database name.

System.String tableName

The table name.

Returns
Type Description
List<IColumn>

A list of column schemas.

| Improve this Doc View Source

GetColumnsAsync(String, String)

Gets the schema of all the columns of a table.

Declaration
Task<List<IColumn>> GetColumnsAsync(string database, string tableName)
Parameters
Type Name Description
System.String database

The database name.

System.String tableName

The table name.

Returns
Type Description
Task<List<IColumn>>

A list of column schemas.

| Improve this Doc View Source

GetConstraints(String, String)

Gets the schema of all the contraints of a table.

Declaration
List<IConstraint> GetConstraints(string database, string tableName)
Parameters
Type Name Description
System.String database

The database name.

System.String tableName

The table name.

Returns
Type Description
List<IConstraint>

A list of constraint schemas.

| Improve this Doc View Source

GetConstraintsAsync(String, String)

Gets the schema of all the contraints of a table.

Declaration
Task<List<IConstraint>> GetConstraintsAsync(string database, string tableName)
Parameters
Type Name Description
System.String database

The database name.

System.String tableName

The table name.

Returns
Type Description
Task<List<IConstraint>>

A list of constraint schemas.

| Improve this Doc View Source

GetParameters(String, String)

Gets the schema of all the parameters of a stored procedure.

Declaration
List<IParameter> GetParameters(string database, string routineName)
Parameters
Type Name Description
System.String database

The database name.

System.String routineName

The routine name.

Returns
Type Description
List<IParameter>

A list of parameter schemas.

| Improve this Doc View Source

GetParametersAsync(String, String)

Gets the schema of all the parameters of a stored procedure.

Declaration
Task<List<IParameter>> GetParametersAsync(string database, string routineName)
Parameters
Type Name Description
System.String database

The database name.

System.String routineName

The routine name.

Returns
Type Description
Task<List<IParameter>>

A list of parameter schemas.

| Improve this Doc View Source

GetStoredProcedures(String, String[])

Gets the schema of stored procedures specifying the database, and allowing to filter which stored procedures to return.

Declaration
List<IStoredProcedure> GetStoredProcedures(string database, params string[] filter)
Parameters
Type Name Description
System.String database

The database name.

System.String[] filter

An array of stored procedure names you want to retrieve.

Returns
Type Description
List<IStoredProcedure>

A list of stored procedure schemas.

| Improve this Doc View Source

GetStoredProceduresAsync(String, String[])

Gets the schema of stored procedures specifying the database, and allowing to filter which stored procedures to return.

Declaration
Task<List<IStoredProcedure>> GetStoredProceduresAsync(string database, params string[] filter)
Parameters
Type Name Description
System.String database

The database name.

System.String[] filter

An array of stored procedure names you want to retrieve.

Returns
Type Description
Task<List<IStoredProcedure>>

A list of stored procedure schemas.

| Improve this Doc View Source

GetTables(String, String[])

Gets the schema of database tables specifying the database, and allowing to filter which tables to return.

Declaration
List<ITable> GetTables(string database, params string[] filter)
Parameters
Type Name Description
System.String database

The database name.

System.String[] filter

An array of table names you want to retrieve.

Returns
Type Description
List<ITable>

A list of table schemas.

| Improve this Doc View Source

GetTablesAsync(String, String[])

Gets the schema of database tables specifying the database, and allowing to filter which tables to return.

Declaration
Task<List<ITable>> GetTablesAsync(string database, params string[] filter)
Parameters
Type Name Description
System.String database

The database name.

System.String[] filter

An array of table names you want to retrieve.

Returns
Type Description
Task<List<ITable>>

A list of table schemas.

| Improve this Doc View Source

GetViews(String, String[])

Gets the schema of database views specifying the database, and allowing to filter which views to return.

Declaration
List<IView> GetViews(string database, params string[] filter)
Parameters
Type Name Description
System.String database

The database name.

System.String[] filter

An array of view names you want to retrieve.

Returns
Type Description
List<IView>

A list of view schemas.

| Improve this Doc View Source

GetViewsAsync(String, String[])

Gets the schema of database views specifying the database, and allowing to filter which views to return.

Declaration
Task<List<IView>> GetViewsAsync(string database, params string[] filter)
Parameters
Type Name Description
System.String database

The database name.

System.String[] filter

An array of view names you want to retrieve.

Returns
Type Description
Task<List<IView>>

A list of view schemas.

Extension Methods

ObjectExtensions.ThrowIfFails<TException>(Object, Action, String)
ObjectExtensions.ThrowIfFails<TException, TResult>(Object, Func<TResult>, String)
ObjectExtensions.ThrowIfFailsAsync<TException>(Object, Func<Task>, String)
ObjectExtensions.ThrowIfFailsAsync<TException, TResult>(Object, Func<Task<TResult>>, String)
  • Improve this Doc
  • View Source
Powered by MiracleDevs ©2017. Code licensed under the MIT License.
Documentation generated by DocFX.