Relationship Class

  • Reference

Definition

Namespace:
Microsoft.AnalysisServices.Tabular
Assembly:
Microsoft.AnalysisServices.Tabular.dll
Package:
Microsoft.AnalysisServices v19.86.2.1

Represents a logical relationship between two Table objects. It is a child of a Model object.

public abstract class Relationship : Microsoft.AnalysisServices.Tabular.NamedMetadataObject
type Relationship = class
    inherit NamedMetadataObject
Public MustInherit Class Relationship
Inherits NamedMetadataObject
Inheritance
Object
MetadataObject
NamedMetadataObject
Relationship
Derived

Properties

Annotations

Gets the collection object of all annotations in the current Relationship.
ChangedProperties

Gets the collection object of all changedproperties in the current Relationship.
CrossFilteringBehavior

Indicates how relationships influence filtering of data. The enumeration defines the possible behaviors. Possible values are as follows. OneDirection (1) The rows selected in the 'To' end of the relationship will automatically filter scans of the table in the 'From' end of the relationship. BothDirections (2) Filters on either end of the relationship will automatically filter the other table. Automatic (3) The engine will analyze the relationships and choose one of the behaviors by using heuristics.
ExtendedProperties

Gets the collection object of all extendedproperties in the current Relationship.
FromTable

Gets the starting table in a directional table relationship.
IsActive

A boolean value that indicates whether the relationship is marked as Active or Inactive. An Active relationship is automatically used for filtering across tables. An Inactive relationship can be used explicitly by DAX calculations with the USERELATIONSHIP function.
IsRemoved

A Boolean specifying whether this object was removed from an object tree.

(Inherited from MetadataObject)
JoinOnDateBehavior

When joining two date time columns, indicates whether to join on date and time parts, or on date part only. DateAndTime (1) When joining two date time columns, join on date and time parts. DatePartOnly (2) When joining two date time columns, join on date part only.
Model

Gets the Tabular model that contains this object.

(Inherited from MetadataObject)
ModifiedTime

The time that the object was last modified.
Name

Gets or Sets the Name of this object.
ObjectType

Gets the type of the object.
Parent

Parent object, null for Model objects.
RefreshedTime

The time that the object was last refreshed.
RelyOnReferentialIntegrity

Unused; reserved for future use.
SecurityFilteringBehavior

Indicates how relationships influence filtering of data when evaluating row-level security expressions. Possible values are as follows. OneDirection (1): The rows selected in the 'To' end of the relationship will automatically filter scans of the table in the 'From' end of the relationship. BothDirections (2): Filters on either end of the relationship will automatically filter the other table.
State

Provides information on the state of the relationship. Possible values and their interpretation are as follows. Ready (1) The relationship is queryable and has up-to-date data. NoData (3) Not applicable to relationships. CalculationNeeded (4) The relationship does not contain any data because it was not refreshed. There is no error associated with the relationship. SemanticError (5) Not applicable to Relationship. EvaluationError (6) Not applicable to Relationship. DependencyError (7) A dependency associated with this relationship is in an error state (SemanticError, EvaluationError, or DependencyError). Incomplete (8) Not applicable to relationships. SyntaxError (9) Not applicable to relationships.
ToTable

Gets the destination table in a directional table relationship.
Type

The type of Relationship. At present, the only possible value is SingleColumn (1) or a normal column-column relationship.

Methods

Clone()

Creates a new, full copy of a Relationship object.
CopyFrom(Relationship)
Obsolete.

Deprecated. Use CopyTo method instead.
CopyTo(Relationship)

Copies a Relationship object to the specified object.
Rename(String)
Obsolete.

Deprecated. Use RequestRename method instead.
RequestRename(String)

Request rename of this object.
Validate()

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

(Inherited from MetadataObject)

Applies to