QueryDataEntity Class

This class defines a query data entity which allows for storing a queries structure as well as the data to be sent as a result of the query.

Inheritance Hierarchy

System Object

  Scribe.Core.ConnectorApi.Query QueryDataEntity

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

Syntax

public class QueryDataEntity

The QueryDataEntity type exposes the following members.

Constructors

 

Name

Description

Public method

QueryDataEntity

Basic constructor for the query data entity

Public method

QueryDataEntity(String)

Constructor for the query data entity, defines the reference name of the entity

Public method

QueryDataEntity(QueryEntity)

Constructor for query data entity, generate an QueryDataEntity from a QueryEntity. This prepares a blue print to insert data into.

Properties

 

Name

Description

Public property

LocalName

The foreign key name of the related table, this will be null if it is the root table

Public property

Name

This is the name that has been assigned by the user, This is a one to one mapping to the 'Name' proeprty in the QueryEntity

Public property

ObjectDefinitionFullName

This is the name of the table in the database

Public property

ParentQueryDataEntity

The query table that this query table is a child of, if this is the root query table this will be null

Public property

Properties

The columns for the table

Public property

Relations

Dictionary containing the list of related entities, the key is the relationship name

Public property

RelationToParent

The relationship to the parent query table, this will be null if this is the root query table

Methods

 

Name

Description

Public method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

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

GetHashCode

Serves as the default hash function.

(Inherited from 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

SetQueryDataEntityRelationship

Set a relationship for any Parent or Child QueryDataEntity using the unique 'Name' field to match on

Public method

ToDataEntity

Convert this QueryDataEntity into a DataEntity

Public method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

Fields

 

Name

Description

Public field

AddedColumns

List of columns that were added for foreign key relations, the will be removed when 'ToDataEntity' is called

See

Scribe.Core.ConnectorApi.Query Namespace