Interface IDatasetQueryableItemJoin

The system entity for a DataSet Queryable Item Join, which belongs to a IDataset and IDatasetQueryableItem

See https://help.lemonedge.com/help/enterprise-data-tools/reporting/datasets/queryable-items-view.html for more information

Inherited Members
Namespace: LemonEdge.API.Entities.Reporting
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.DatasetQueryableItemJoin, "dbo.LT_DatasetQueryableItemJoins", "DatasetQueryableItemJoin")]
[DefaultEntityIcon(ImageType.Attachment)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.SQLWrapper, "OwnerEntityID", "ID", ExcludeFromRelationship = true)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.DataSourceIDs, "EntityID", "ID", ExcludeFromRelationship = true)]
[EntityIndex(Name = "DatasetJoins", ColumnNames = new string[] { "DatasetID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
[EntityIndex(Name = "SourceItemIDCanvas", ColumnNames = new string[] { "SourceDatasetQueryableItemID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
public interface IDatasetQueryableItemJoin : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

DatasetID

Links to IDataset. The parent dataset this join is a member of

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.Dataset, "ID", SingleJoinType.One, "Dataset", "Joins", DeleteWithRelationship = true, PartOfParentSet = true, InheritPermissions = true)]
[RequiredNoDefaultIDValidation]
Guid DatasetID { get; set; }
Property Value
Type Description
Guid

HardcodedValue

Holds a hardcoded value to use for the join value

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
string HardcodedValue { get; set; }
Property Value
Type Description
string

IsNullSourceDatasetQueryableItemID

Links to IDatasetQueryableItem. The source queryable item this is a join from if the initial source has a null value. This can be null if joining to dataset global parameters

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.DatasetQueryableItem, "ID", SingleJoinType.ZeroToOne, "Dataset Queryable Item", "Joins As IsNull", DeleteWithRelationship = true, PartOfParentSet = true, InheritPermissions = false)]
Guid? IsNullSourceDatasetQueryableItemID { get; set; }
Property Value
Type Description
Guid?

IsNullSourceQueryableItemFieldUniqueKey

A property within the selected Source Dataset Queryable Item that you want to use to join to the selected Queryable Item that is used if the initial source has a null value

If the Source is global parameters it will allow a selection from all your parameters.If the source is another queryable item it will provide a list of all fields that queryable item contains.

Declaration
[EntityProperty(SQLType.NVarChar, true)]
string IsNullSourceQueryableItemFieldUniqueKey { get; set; }
Property Value
Type Description
string

SourceDatasetQueryableItemID

Links to IDatasetQueryableItem. The source queryable item this is a join from. This can be null if joining to dataset global parameters

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.DatasetQueryableItem, "ID", SingleJoinType.ZeroToOne, "Source Dataset Queryable Item", "Joins As Source", DeleteWithRelationship = true, PartOfParentSet = true, InheritPermissions = false)]
Guid? SourceDatasetQueryableItemID { get; set; }
Property Value
Type Description
Guid?

SourceQueryableItemFieldUniqueKey

A property within the selected Source Dataset Queryable Item that you want to use to join to the selected Queryable Item.

If the Source is global parameters it will allow a selection from all your parameters.If the source is another queryable item it will provide a list of all fields that queryable item contains.

Declaration
[EntityProperty(SQLType.NVarChar, true)]
string SourceQueryableItemFieldUniqueKey { get; set; }
Property Value
Type Description
string

TargetDatasetQueryableItemID

Links to IDatasetQueryableItem. The parent queryable item this join is a target to

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.DatasetQueryableItem, "ID", SingleJoinType.One, "Target Dataset Queryable Item", "Joins As Target", DeleteWithRelationship = true, PartOfParentSet = true, InheritPermissions = false)]
[RequiredNoDefaultIDValidation]
Guid TargetDatasetQueryableItemID { get; set; }
Property Value
Type Description
Guid

TargetQueryableItemFieldUniqueKey

This is the property on the selected queryable item that you want to use to join to the source queryable item.

This will list all fields against this queryable item, and if it has parameters(is a query queryable item) those will also be listed allowing you to pass values into the parameters as part of the join.Doing so will force the join to be an outer apply join.

Declaration
[EntityProperty(SQLType.NVarChar, false)]
[Required]
string TargetQueryableItemFieldUniqueKey { get; set; }
Property Value
Type Description
string

Extension Methods

See Also