Class ReportDataQuery

Namespace

DocWright.Reporting.Data

Assembly

DocWright.Reporting.dll

One dataset's query as a data provider receives it: which dataset, which data source, and the command text and parameters with every expression already evaluated.

public sealed class ReportDataQuery

Inheritance

object

ReportDataQuery

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Nothing here is executed or interpreted by DocWright. The connection string in particular is passed on as the definition states it, and a host that serves reports it did not write should map DataSourceName to a connection of its own rather than trust it.

Constructors

ReportDataQuery(string, string?, IReadOnlyList<ReportQueryParameter>?)

Initializes a query.

Properties

CommandText

Gets the evaluated command text, or null.

CommandType

Gets or sets the query's CommandType: Text, StoredProcedure or TableDirect; null when not stated.

ConnectString

Gets or sets the data source's evaluated connection string, or null.

DataProvider

Gets or sets the data source's DataProvider, such as SQL, or null.

DataSetName

Gets the dataset's name, exactly as the definition declares it.

DataSourceName

Gets or sets the name of the data source the query names, or null.

DataSourceReference

Gets or sets the data source's DataSourceReference — a shared data source — or null.

DeclaredFields

Gets or sets the column names the dataset's fields read (their DataField), in document order and without calculated fields — the columns the report expects the reader to have.

Parameters

Gets the evaluated query parameters, in document order.

TimeoutSeconds

Gets or sets the query's timeout in seconds, or null when not stated.