[EntityDefinition(EntityID.Dataset, "dbo.LT_Datasets", "Dataset", LabelColumn = "Name", IsStandingDataEntity = false, HelpURL = "help/enterprise-data-tools/reporting/datasets/intro.html")]
[DefaultEntityIcon(ImageType.Dataset)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.DataSourceIDs, "EntityID", "ID", ExcludeFromRelationship = true)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.SQLWrapper, "OwnerEntityID", "ID", PartOfThisSet = true)]
[EntityIndex(Name = "Name", ColumnNames = new string[] { "UserID", "Name" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending, IndexOrder.Ascending }, IncludeColumns = new string[] { "SafeID", "IsSystem", "Version", "Description", "AlgorithmStepID", "FolderID" }, IsClustered = false, IsUnique = false)]
public interface IDataset : IBaseEntityWithPermissions, ISetCopier, IHasVersion, IUserSpecific, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

DatasetTemplateID

The link to the dataset shortcut that is using this datase as a template

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.DatasetShortcut, "ID", SingleJoinType.ZeroToOne, "Dataset Shortcut", "Dataset", DeleteWithRelationship = true, PartOfParentSet = true, InheritPermissions = false, PreventAutoConstraint = false)]
[EntityDescription("The link to the dataset shortcut that is using this datase as a template.")]
Guid? DatasetTemplateID { get; set; }

Property Value

Type	Description
Guid?

Description

A user friendly description of this dataset

Declaration

[EntityProperty(SQLType.NVarChar, 2000, true)]
[EntityDescription("A user friendly description of this dataset.")]
string Description { get; set; }

Property Value

Type	Description
string

Distinct

Indicates all rows returned must be distinct removing any duplicate values

Declaration

[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates if only distinct row results should be returned in this dataset.")]
bool Distinct { get; set; }

Property Value

Type	Description
bool

Name

The unique user friendly name of this dataset

Declaration

[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this dataset.")]
[Unique]
[Required]
string Name { get; set; }

Property Value

Type	Description
string

SQLWrapperID

The link to the SQL Wrapper that allows you to execute this dataset, and otherwise interact with it throughout the whole LemonEdge platform.

This is automatically created and maintained by the system.You can leave it blank when creating a dataset.

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.SQLWrapper, "ID", SingleJoinType.One, "SQL Wrapper", "Dataset", DeleteWithRelationship = true, LinkToItemInSet = true, InheritPermissions = false, PreventAutoConstraint = true)]
[RequiredNoDefaultIDValidation]
[EntityDescription("Holds the sql wrapper this query generates.")]
Guid SQLWrapperID { get; set; }

Property Value

Type	Description
Guid

SetMethod

Specifies the method to use for combining data together - either a single statement or via temp tables

Declaration

[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Specifies the method to use for combining data together - either a single statement or via temp tables.")]
DataSetSetOperatorMethod SetMethod { get; set; }

Property Value

Type	Description
DataSetSetOperatorMethod

Skip

Indicates the dataset should skip the specified number of rows (requires an order in the Columns) before returning the remaining amount

Declaration

[EntityProperty(SQLType.Int, true)]
[EntityDescription("Indicates if the specified number of rows should be skipped before returning the rows in this dataset.")]
int? Skip { get; set; }

Property Value

Type	Description
int?

Top

Indicates the dataset should always only return the following number of rows

Declaration

[EntityProperty(SQLType.Int, true)]
[EntityDescription("Indicates if just the top specified number of rows should be returned in this dataset.")]
int? Top { get; set; }