Class Field
- Inheritance
-
Field
- Implements
- Derived
- Inherited Members
- Assembly
- SemanticBridge.dll
Represents a field definition in a Databricks Metric View
public class Field : MetricViewObjectBase, IMetricViewObject, IMetricViewNamedObject
- Extension Methods
Remarks
A field in a Metric View is a single field. There is no namespacing or delineation of separate named collections of fields.
Properties
Comment
Description of the field. Requires version 1.1+.
[MinVersion("1.1")]
public string? Comment { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
DisplayName
Human-readable display name. Requires version 1.1+.
[MinVersion("1.1")]
public string? DisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Expr
The YAML string representing the expression for this field, either a field reference or scalar SQL expression.
public required string Expr { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Format
Display format specification. Requires version 1.1+.
[MinVersion("1.1")]
public Format? Format { get; set; }
Property Value
| Type | Description |
|---|---|
| Format |
Name
The YAML name for the field
public required string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Path
public override string Path { get; }
Property Value
| Type | Description |
|---|---|
| string |
Synonyms
Alternative names for AI/search. Requires version 1.1+.
[MinVersion("1.1")]
public List<string>? Synonyms { get; set; }
Property Value
| Type | Description |
|---|---|
| List<string> |
Methods
Delete()
Deletes this object from its parent collection. After deletion, the object becomes a zombie (IsDeleted=true, View=null).
public override void Delete()
Exceptions
- InvalidOperationException
Thrown if the object is not attached to a View or is already deleted.
ToString()
Masks the runtime Dimension type name introduced by
the legacy shim so logs, debugger tooltips, and default
ToString() consumers always see the canonical "Field" label
regardless of which subtype currently backs the instance.
public override string ToString()
Returns
| Type | Description |
|---|---|
| string |