Documentation

Class DbSchemaReader

Inheritance
System.Object
DbSchemaReader
DbSchemaReaderImp
Namespace: Telerik.OpenAccess.Runtime.Schema
Assembly: Telerik.OpenAccess.Runtime.dll

Syntax

public abstract class DbSchemaReader

Constructors

DbSchemaReader()

Declaration
protected DbSchemaReader()

Properties

ADODriver

Declaration
public abstract AssemblyName ADODriver { get; }
Property Value
System.Reflection.AssemblyName

Backend

Declaration
public abstract DbSchemaReader.ISchemaReaderInformation Backend { get; }
Property Value
DbSchemaReader.ISchemaReaderInformation

LoggingProvider

Declaration
public ILogEventFactory LoggingProvider { protected get; set; }
Property Value
ILogEventFactory

MetadataContainer

Declaration
public MetadataContainer MetadataContainer { get; }
Property Value
MetadataContainer

ReadColumns

Declaration
public bool ReadColumns { get; set; }
Property Value
System.Boolean

ReadConstraints

Declaration
public bool ReadConstraints { get; set; }
Property Value
System.Boolean

ReadFunctions

Declaration
public bool ReadFunctions { get; set; }
Property Value
System.Boolean

ReadIndexes

Declaration
public bool ReadIndexes { get; set; }
Property Value
System.Boolean

ReadPrimaryKeys

Declaration
public bool ReadPrimaryKeys { get; set; }
Property Value
System.Boolean

ReadProcedures

Declaration
public bool ReadProcedures { get; set; }
Property Value
System.Boolean

ReadTables

Declaration
public bool ReadTables { get; set; }
Property Value
System.Boolean

ReadViews

Declaration
public bool ReadViews { get; set; }
Property Value
System.Boolean

RelationalProcedures

Declaration
public abstract List<RelationalProcedure> RelationalProcedures { get; }
Property Value
System.Collections.Generic.List<OpenAccessRuntime.Relational.metadata.RelationalProcedure>

RelationalTables

Declaration
public abstract Dictionary<string, RelationalTable> RelationalTables { get; }
Property Value
System.Collections.Generic.Dictionary<System.String, OpenAccessRuntime.Relational.metadata.RelationalTable>

RelationalUDTs

Declaration
public abstract Dictionary<string, RelationalUDT> RelationalUDTs { get; }
Property Value
System.Collections.Generic.Dictionary<System.String, OpenAccessRuntime.Relational.metadata.RelationalUDT>

SchemaFilter

Declaration
public List<string> SchemaFilter { get; }
Property Value
System.Collections.Generic.List<System.String>

Methods

BeginExecute(Action<DbSchemaReader>)

Declaration
public abstract void BeginExecute(Action<DbSchemaReader> action)
Parameters
System.Action<DbSchemaReader> action

Create(DbConnection)

Declaration
public static DbSchemaReader Create(DbConnection connection)
Parameters
System.Data.Common.DbConnection connection

Returns
DbSchemaReader

Create(DbConnection, Backend)

Declaration
public static DbSchemaReader Create(DbConnection connection, Backend backendType)
Parameters
System.Data.Common.DbConnection connection

Backend backendType

Returns
DbSchemaReader

Execute()

Declaration
public abstract void Execute()

GetAllSchemaNames()

Declaration
public abstract List<string> GetAllSchemaNames()
Returns
System.Collections.Generic.List<System.String>

GetContainer()

Declaration
protected abstract MetadataContainer GetContainer()
Returns
MetadataContainer

GetDatabases()

Declaration
public abstract List<string> GetDatabases()
Returns
System.Collections.Generic.List<System.String>

GetDefaultSchema()

Declaration
public abstract string GetDefaultSchema()
Returns
System.String

GetObjectNames(String)

Declaration
public abstract List<string> GetObjectNames(string filter)
Parameters
System.String filter

Returns
System.Collections.Generic.List<System.String>

GetProcedureResultShape(MetaStoredProcedure)

Declaration
public abstract MetaStoredProcedure GetProcedureResultShape(MetaStoredProcedure procedure)
Parameters
MetaStoredProcedure procedure

Returns
MetaStoredProcedure

OnProgress(DbSchemaReader.SchemaReadEventArgs.SchemaReadPhase, Int32, Int32)

Declaration
protected virtual void OnProgress(DbSchemaReader.SchemaReadEventArgs.SchemaReadPhase phase, int counter, int max)
Parameters
DbSchemaReader.SchemaReadEventArgs.SchemaReadPhase phase

System.Int32 counter

System.Int32 max

ReadAdditionalDatabase(String)

Declaration
public abstract AdditionalDatabase ReadAdditionalDatabase(string databaseName)
Parameters
System.String databaseName

Returns
AdditionalDatabase

Events

Progress

Declaration
public event EventHandler<DbSchemaReader.SchemaReadEventArgs> Progress
Event Type
System.EventHandler<DbSchemaReader.SchemaReadEventArgs>