Query Class

Encapsulates a request for data

Inheritance Hierarchy

System Object

  Scribe.Core.ConnectorApi.Query Query

Namespace:  Scribe.Core.ConnectorApi.Query
Assembly:  Scribe.Core.ConnectorApi (in Scribe.Core.ConnectorApi.dll)

Syntax

[DataContractAttribute]
[KnownTypeAttribute(typeof(QueryEntity))]
[KnownTypeAttribute(typeof(Expression))]
[KnownTypeAttribute(typeof(ComparisonExpression))]
[KnownTypeAttribute(typeof(LogicalExpression))]
public class Query : IEqualityComparer<Query>

The Query type exposes the following members.

Constructors

 

Name

Description

Public method

Query

Default constructor

Public method

Query(String)

Native Query constructor Set nativeQueryText to text of Connector specific query

Properties

 

Name

Description

Public property

Constraints

The expression used to filter the query

Public property

IsNativeQuery

Indicates that this query is an Connector specific query

Public property

IsTestQuery

Defines this query as a test query

Public property

NativeQueryText

Contains the text of an Connector specific query

Public property

RootEntity

The Entity at the root of the query

Public property

RowLimit

Defines the top X rows the caller is expecting, a default value of zero expects all results from the query.

Methods

 

Name

Description

Public method Static member

CloneQuery

Creates a new object that is a copy of the current instance.

Public method

Equals(Object)

This method will return whether this object and the passed in object are equal.

(Overrides Object Equals(Object).)

Public method

Equals(Query, Query)

This method will return whether the two passed in objects are equal.

Protected method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

(Inherited from Object.)

Public method

FindQueryEntityByName

This method will return the QueryEntity that matches the passed in name or null if not found.

Public method

GetAllProperties

Return all properties used by the root entity and all of it's children

Public method

GetHashCode

This method will return the hashcode of this object.

(Overrides Object GetHashCode .)

Public method

GetHashCode(Query)

This method will return the hashcode of the passed in object.

Public method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

Protected method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

Public method

OnDeserialized

This method will call the RootEntity and Constraints to perform their deserialized work that will tie the parents to their children.

Public method

ToString

Returns text of query for use in UI

(Overrides Object ToString .)

See

Scribe.Core.ConnectorApi.Query Namespace