| Query Class |
|
Object representing a query.
Inheritance Hierarchy
Namespace: DataPA.Utils.QueryEngine
Assembly: DataPAQueryEngine (in DataPAQueryEngine.dll) Version: 1.0.0.0 (1.0.0.0)
Syntaxpublic class Query : _Query, ISerializable, ITelemetry
The Query type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Query |
Creates and returns a new query object
|
| Query(Byte, Systems) |
Creates and returns a new query object from a saved byte array
|
| Query(String, Systems) |
Creates and returns a new query object from a saved query string
|
Methods| Name | Description | |
|---|---|---|
| AuthenticateInmydataAccount | |
| AvailableProfiles |
Generates and returns the available profiles for the current Google Account
|
| CheckSystemandSubjectsValid | |
| Clone |
Creates and returns an absolute copy of this query
|
 | ComparableTypes |
Compares two data types and returns true if they are comparable
|
| FieldDataTypeFromColumnDataType | |
| GenerateField |
Generates a field object given a data column
|
| GenerateFields |
Generates a fields collection for a given datatable
|
| GetObjectData | |
| GetRequiredFieldInfo |
Builds string arrays of parameter information which will be used when publishing
|
| GetTelemetryMetrics | |
| GetTelemetryProperties | |
| GoogleMetaData |
Generates and returns the Google Meta data
|
| GoogleMetaData(Boolean) |
Generates and returns the Google Meta data
|
| Import |
Imports data from the ImportFile
|
| IsInmydataAuthenticated | |
| IsValueSet | |
| Open |
Opens a new query object from a saved query string
|
| OpenFromBytes |
Opens a new query from a saved byte array
|
| OpenFromFile |
Opens a new query object from a saved query string
|
| QueryResults |
Gets the first query data set from this queries results set
|
| QueryResults(Int32) |
Gets a given query data set from this queries results set
|
| RaiseDataAvailableEvent | |
| ResetGoogleAPI |
Clears all saved tokens and resets the API object
|
| ResetIDs |
Resets the Unique ID for this query and any descendents
|
| RunQuery | |
| Save(Stream) |
Saves this query to the given stream
|
| Save(String) |
Saves this query to the given file
|
| SetObjectData | |
| SetRequiredValue |
Allows 3rd party applications to set the value of a paremeter and prevent it from being prompted for by the run query wizard
|
| SetSkipValue |
Allows 3rd party applications to set a paremeter to be skipped and prevent it from being prompted for by the run query wizard
|
| StoreAccessTokens |
Requests that the any access tokens required for this query are stored in the query for publish
|
| ToByte |
Gets this query stored as a byte array
|
| ToSaveString |
Gets this query stored as a string
|
| ToString |
Gets a string that describes this query
(Overrides ObjectToString.) |
Fields| Name | Description | |
|---|---|---|
 | ClassId | |
| EventsId | |
| InterfaceId | |
| StoredAccessToken |
Properties| Name | Description | |
|---|---|---|
 | Author |
Gets and sets the name of the person who created this query
|
| BlendingDetails |
Gets and sets an object that defines the properties required for a blending query
|
| BusinessLogicFixedValueParameterValues |
Gets and sets a dictionary of objects that represent the values to populate the business logic parameters for the subject used in this query
|
| Category |
Gets and sets the category this query will be published too
|
| Children |
Gets the collection of child queries
|
| ChildrenList |
Gets and sets a list of child subjects of this query
|
| ClearData |
Gets and sets a property that indicates if an accumulating query should clear data on this refresh
|
| CombineResults |
Gets and sets a value that indicates if the results of a multi level query should be combined into a single dataset
|
| Comments |
Gets and sets a comments string for this query
|
| Conditions |
Gets and sets an list of query conditions to be applied to this query
|
| DataSetName |
Gets a property that indicates the dataset name that will be used for this query's results
|
| DebugQuery |
Gets and sets a property that indicates if this query will run in debug mode.
|
| DecimalSeparator |
Gets and sets the Decimal separator
|
| Description |
Gets and sets a description for this query
|
| DisplayFields |
Gets and sets the display fields for this query
|
| ErrorMessage |
Gets and sets a string that will contain any error recorded at the time this query was last run
|
| ExcelExportProperties |
Gets and sets an object that describes
|
| ExcelImportProperties |
Gets and sets an object that describes
|
| FieldLabelsChanged |
Gets a dicionary of the fields that have changed name since the query was last opened
|
| ForcedConnectionID |
Gets and sets the ID of the connection this query is forced to use
|
| GoogleAnalyticsDetails |
Gets ansd sets an object that defines the properties for a Google Analytics query
|
| ID |
Gets a unique identifier for this object
|
| ImportFile |
Gets and sets the path of the file from which this query will import data
|
| inmydataSourceData |
Gets and sets the source data for this inmydata query
|
| inmydataTenant |
Gets and sets the name of the tenant for this inmydata query
|
| InnerJoin |
Gets and sets a property that indicates if this object is joined to it's parent with an inner join
|
| Keywords |
Gets and sets a list of keywords to identify this object
|
| LastRefreshCompleted |
Gets and sets the date and time this query was last refreshed
|
| LastRefreshCompletedNotNullable |
Gets and sets the date and time this query was last refreshed
|
| LastRefreshStarted |
Gets and sets the date and time the last refresh of this query started
|
| LastRefreshStartedNotNullable |
Gets and sets the date and time the last refresh of this query started
|
| MaxRows |
Gets and sets the maximum number of rows for this query to return
|
| MillisecondsTakenLastSuccessfulRefresh |
Gets the number of milliseconds taken for the last succesfull refresh of this query
|
| Modified |
Gets a property that indicates if the Query has been modified since it was last saved.
|
| Name |
Gets and sets the name of this query
|
| ObjectSizes |
Gets a dictionary of serialized objects contained in this object, along with their sizes (in bytes)
|
| OpenAPIClassFile |
Gets and sets a string that identifies the Open API assembly file that will be used to provide data
|
| OpenAPIClassIdentifier |
Gets and sets a string that identifies the Open API class that will be used to provide data
|
| OpenAPIConfigurationString |
Gets and sets the configuration string used in conjunction with the OpenAPI class to generate data
|
| OpenAPIRuntimeConfigurationString |
Gets the configuration string used in conjunction with the OpenAPI class to generate data, with any required field values populated
|
| ParameterParentColumns |
Gets and sets a dictionary of fields that represent the parent columns used to provide values for a required field in for this subject in a multi-level query
|
| Parameters |
Gets the query parameters collection
|
| ParametersList |
Gets and sets a dictionary of parameter objects for this query
|
| Parent |
Gets and sets the parent query
|
| QueryBasedOnSubject |
Gets a value that indicates if this query is dependent on a subject
|
| QueryBasedOnSystem |
Gets a value that indicates if this query is dependent on a system
|
| QueryLookups | |
| QueryType |
Gets and sets a value that identifies the type of this query
|
| RequiredFields |
Gets the query parameters collection (depricated, use parameters)
|
| ResultsSet |
Gets and sets property that contains the datasets for this query.
|
| RootQuery |
Gets the root query of this query
|
| SavedDataAvailable |
Gets a boolean value that indicates if the file required to run a test execution of this query exists and the query has data
|
| SavedDataFile |
Gets the fully qualified path of the file required to run a test execution of this query
|
| Silent |
Gets and sets a property that indicates whether the run query screen should be fully hidden in the client if possible
|
| SkipExport |
Gets and sets a property that indicates if the export screen should be skipped in the rubn query wizard
|
| SkipIntro |
Gets and sets a property that indicates whether the run query wizard will be forced to skip the introduction screen regardless of the users settings
|
| SortFields |
Gets and sets a list of columns used to sort the data from this query
|
| SourceFields |
Gets and sets a collection of fields available from the source dataset
|
| SplitResults |
Gets and sets a property that indicates if this query will return multiple result sets
|
| SQLString |
Gets and sets the SQL Query string for this query
|
| StoredData |
Gets and sets a string that can be used to store any data string in this query
|
| Subject |
Gets the subject object that this query is based on
|
| SubjectID |
Gets and sets the ID of the subject used for this query
|
| SubjectTitle |
Gets a property that indicates the title of the Subject this Query uses.
|
| SubjectType |
Gets a property that indicates the type of the Subject this Query uses.
|
| Summarise |
Gets and sets a property that indicates whether this query will summarise the data returned by the Open API query
|
| SummaryFill |
Gets and sets a value that indicates if any date groupings in a summary query should populate periods without any data
|
| SystemName |
Gets and sets the system name this query relates to (if any)
|
| Systems |
Gets and sets the systems object that the subject this query relates to should belong to
|
| ThousandSeparator |
Gets and sets the thousand separator
|
| TrendingDetails |
Gets and sets the trending details for this query
|
| UseLabels |
Gets and sets a property that indicates if this query should us the fields labels in the dataset.
|
| UseParametersAsDefault |
Gets and sets a value that indicates if the parameter values in this query should be used as the default values for the query required fields
|
| UserLevel |
Gets and sets the user level for this query
|
| Version |
Gets and sets the version for this query
|
Events| Name | Description | |
|---|---|---|
 | DataAvailable |
Event raised when the data is available for this query from the queyr having been run.
|
| ParameterValueRequest |
Event raised for each parameter before the query is run, allowing parameter values to be set by a third party application
|
| QueryProgress |
Event raised to indicate the progress of a query refresh process
|
| SourceDataRequest |
Event raised when the query requires a source data set to be provided for a blending query
|
See Also