StoredProcedures_Base class

An abstract class that represents the database stored procedures. The class is overwritten every time the code is regenerated.

Do not change this file manually. Modify the StoredProcedures class if you need to add or change some functionality.

Constructors


C#:
public StoredProcedures_Base(
      <DatabaseCodeName> db
);

VB.NET:
Public Sub New( _
      db As <DatabaseCodeName> _
)

Description

Initializes a new instance of the StoredProcedures_Base class.

Parameters

db

The database object.

Properties


C#:
protected <DatabaseCodeName> Database {get;}

VB.NET:
Protected ReadOnly Property Database As <DatabaseCodeName>

Description

Gets the database object that these stored procedures belong to.

Methods


C#:
protected System.Data.DataTable CreateDataTable(
      System.Data.IDbCommand cmd
);

VB.NET:
Protected Function CreateDataTable( _
      cmd As System.Data.IDbCommand _
) As System.Data.DataTable

Description

Retrieves data from DB using the specified command and returns results in a System.Data.DataTable object.

Parameters

cmd

The command object to retrieve data.

Returns

A reference to the System.Data.DataTable object.

C#:
public virtual System.Data.IDbCommand <StoredProcedureCodeName>Command(
       <StoredProcedureParameterType1> <parameterName1>,
       <StoredProcedureParameterTypeN> <parameterNameN>
);

VB.NET:
Protected Overridable Function CreateDeleteBy<ForeignKeyColumnName>Command( _
      <foreignKeyColumnName> As <StoredProcedureParameterType1>, _
      <parameterNameN> As <StoredProcedureParameterTypeN> _
) As System.Data.IDbCommand

Description

Creates a command object that can be used to call the wrapped stored procedure.

Parameters

parameterName1, parameterNameN

The stored procedure parameters.

Returns

A reference to the System.Data.IDbCommand object.

C#:
public virtual System.Data.DataTable <StoredProcedureCodeName>DataTable(
       <StoredProcedureParameterType1> <parameterName1>,
       <StoredProcedureParameterTypeN> <parameterNameN>
);

VB.NET:
Public Overridable Function <StoredProcedureCodeName>DataTable( _
      <foreignKeyColumnName> As <StoredProcedureParameterType1>, _
      <parameterNameN> As <StoredProcedureParameterTypeN> _
) As System.Data.DataTable

Description

Invokes the wrapped stored procedure and returns output data in a DataTable object.

Parameters

parameterName1, parameterNameN

The stored procedure parameters.

Returns

A reference to the System.Data.DataTable object.