Class DataSource

Inheritance

object

DynamicPropertyObject

TabularObject

TabularNamedObject

DataSource

Implements

ICustomTypeDescriptor

INotifyPropertyChanging

ITabularNamedObject

INamedObject

IComparable

IDescriptionObject

IAnnotationObject

IExtendedPropertyObject

ITabularObject

INotifyPropertyChanged

Derived

ProviderDataSource

StructuredDataSource

Inherited Members

TabularNamedObject.CanEditName()

TabularNamedObject.CanDelete()

TabularNamedObject.CanDelete(out string)

TabularNamedObject.Delete()

TabularNamedObject.Init()

TabularNamedObject.CompareTo(object)

TabularNamedObject.MetadataIndex

TabularNamedObject.MetadataObject

TabularNamedObject.Name

TabularObject.SetValue(object, object, Action<object>, string)

TabularObject.SetValue<T>(T, T, Action<T>, string)

TabularObject.CustomReinit()

TabularObject.Children_CollectionChanged(object, NotifyCollectionChangedEventArgs)

TabularObject.OnPropertyChanging(string, object, ref bool, ref bool)

TabularObject.IsRemoved

TabularObject.Model

TabularObject.ObjectType

TabularObject.ObjectTypeName

TabularObject.PropertyChanged

TabularObject.PropertyChanging

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace

TabularEditor.TOMWrapper

Assembly

TOMWrapper.dll

Defines an open connection to an external data source for import, refresh, or DirectQuery operations on a Tabular Model.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public abstract class DataSource : TabularNamedObject, ICustomTypeDescriptor, INotifyPropertyChanging, ITabularNamedObject, INamedObject, IComparable, IDescriptionObject, IAnnotationObject, IExtendedPropertyObject, ITabularObject, INotifyPropertyChanged

Extension Methods

ScriptHelper.Output(object)

Properties

Annotations

The collection of Annotations on the current Data Source.

    C#
    
        
        Copy
        

            
                
            
        
    
  
[Browsable(true)]
public AnnotationCollection Annotations { get; }

Property Value

Type	Description
AnnotationCollection

Description

The description of the data source, visible to developers at design time and to administrators in management tools, such as SQL Server Management Studio.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public string Description { get; set; }

Property Value

Type	Description
string

ExtendedProperties

The collection of Extended Properties on the current Data Source.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public ExtendedPropertyCollection ExtendedProperties { get; }

Property Value

Type	Description
ExtendedPropertyCollection

MaxConnections

The maximum number of connections to be opened concurrently to the data source.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public int MaxConnections { get; set; }

Property Value

Type	Description
int

Parent

The parent Model of the current Data Source.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public Model Parent { get; }

Property Value

Type	Description
Model

Type

The type of DataSource. At present, the only possible value is Provider, which refers to a data source that accepts a connection string.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public DataSourceType Type { get; }

Property Value

Type	Description
DataSourceType

UsedByPartitions

Enumerates the partitions that use this data source

    C#
    
        
        Copy
        

            
                
            
        
    
  
[Browsable(false)]
public IEnumerable<Partition> UsedByPartitions { get; }

Property Value

Type	Description
IEnumerable<Partition>

UsedByTables

Enumerates the tables that use this data source

    C#
    
        
        Copy
        

            
                
            
        
    
  
[Browsable(false)]
public IEnumerable<Table> UsedByTables { get; }

Property Value

Type	Description
IEnumerable<Table>

Methods

AllowDelete(out string)

Derived classes should override this method to prevent an object from being deleted. If left un-overridden, always returns TRUE and sets message to null.

    C#
    
        
        Copy
        

            
                
            
        
    
  
protected override bool AllowDelete(out string message)

Parameters

Type	Name	Description
string	message	If an object CANNOT be deleted, this string should provide a reason why. If an object CAN be deleted, this string may optionally provide a suitable warning message that applies if the object is deleted immediately after the call to CanDelete.

Returns

Type	Description
bool	True if an object can be deleted. False otherwise.

ClearAnnotations()

Removes all annotations from this object.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public void ClearAnnotations()

ClearExtendedProperties()

Removes all Extended Properties from this object.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public void ClearExtendedProperties()

GetAnnotation(int)

Gets the value of the annotation with the given index, assuming it exists.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public string GetAnnotation(int index)

Parameters

Type	Name	Description
int	index

Returns

Type	Description
string

GetAnnotation(string)

Gets the value of the annotation with the given name. Returns null if no such annotation exists.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public string GetAnnotation(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
string

GetAnnotations()

Gets a collection of all annotation names on the current Data Source.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public IEnumerable<string> GetAnnotations()

Returns

Type	Description
IEnumerable<string>

GetAnnotationsCount()

Gets the number of annotations on the current Data Source.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public int GetAnnotationsCount()

Returns

Type	Description
int

GetExtendedProperties()

Gets a collection of all ExtendedProperty names on the current object.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public IEnumerable<string> GetExtendedProperties()

Returns

Type	Description
IEnumerable<string>

GetExtendedProperty(int)

Gets the value of the ExtendedProperty with the given index, assuming it exists.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public string GetExtendedProperty(int index)

Parameters

Type	Name	Description
int	index

Returns

Type	Description
string

GetExtendedProperty(string)

Gets the value of the ExtendedProperty with the given name. Returns null if no such ExtendedProperty exists.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public string GetExtendedProperty(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
string

GetExtendedPropertyCount()

Gets the number of ExtendedProperties on the current object.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public int GetExtendedPropertyCount()

Returns

Type	Description
int

GetExtendedPropertyType(int)

Gets the type of the ExtendedProperty with the given index, assuming it exists.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public ExtendedPropertyType GetExtendedPropertyType(int index)

Parameters

Type	Name	Description
int	index

Returns

Type	Description
ExtendedPropertyType

GetExtendedPropertyType(string)

Gets the type of the ExtendedProperty with the given name, assuming it exists.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public ExtendedPropertyType GetExtendedPropertyType(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
ExtendedPropertyType

GetNewAnnotationName()

Returns a unique name for a new annotation.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public string GetNewAnnotationName()

Returns

Type	Description
string

GetNewExtendedPropertyName()

Returns a unique name for a new ExtendedProperty.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public string GetNewExtendedPropertyName()

Returns

Type	Description
string

HasAnnotation(string)

Returns true if an annotation with the given name exists. Otherwise false.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public bool HasAnnotation(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
bool

HasExtendedProperty(string)

Returns true if an ExtendedProperty with the given name exists. Otherwise false.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public bool HasExtendedProperty(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
bool

OnPropertyChanged(string, object, object)

Fired after a property is changed

    C#
    
        
        Copy
        

            
                
            
        
    
  
protected override void OnPropertyChanged(string propertyName, object oldValue, object newValue)

Parameters

Type	Name	Description
string	propertyName
object	oldValue
object	newValue

RemoveAnnotation(string)

Remove an annotation by the given name.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public void RemoveAnnotation(string name)

Parameters

Type	Name	Description
string	name

RemoveExtendedProperty(string)

Remove an ExtendedProperty by the given name.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public void RemoveExtendedProperty(string name)

Parameters

Type	Name	Description
string	name

SetAnnotation(int, string)

Sets the value of the annotation with the given index, assuming it exists.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public void SetAnnotation(int index, string value)

Parameters

Type	Name	Description
int	index
string	value

SetAnnotation(string, string)

Sets the value of the annotation having the given name. If no such annotation exists, it will be created. If value is set to null, the annotation will be removed.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public void SetAnnotation(string name, string value)

Parameters

Type	Name	Description
string	name
string	value

SetExtendedProperty(int, string, ExtendedPropertyType)

Sets the value of the ExtendedProperty with the given index, optionally specifiying the type (string or JSON) of the ExtendedProperty.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public void SetExtendedProperty(int index, string value, ExtendedPropertyType type)

Parameters

Type	Name	Description
int	index
string	value
ExtendedPropertyType	type

SetExtendedProperty(string, string, ExtendedPropertyType)

Sets the value of the ExtendedProperty having the given name. If no such ExtendedProperty exists, it will be created. If value is set to null, the ExtendedProperty will be removed.

    C#
    
        
        Copy
        

            
                
            
        
    
  
public void SetExtendedProperty(string name, string value, ExtendedPropertyType type)

Parameters

Type	Name	Description
string	name
string	value
ExtendedPropertyType	type