Show / Hide Table of Contents

Class FileShareDataset

An on-premises file system dataset.

Inheritance
System.Object
Dataset
FileShareDataset
Inherited Members
Dataset.AdditionalProperties
Dataset.Annotations
Dataset.Description
Dataset.Folder
Dataset.LinkedServiceName
Dataset.Parameters
Dataset.Schema
Dataset.Structure
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.FileShareDataset/FileShareDatasetConverter))]
public class FileShareDataset : Azure.Analytics.Synapse.Artifacts.Models.Dataset

Constructors

FileShareDataset(LinkedServiceReference)

Initializes a new instance of FileShareDataset.

Declaration
public FileShareDataset (Azure.Analytics.Synapse.Artifacts.Models.LinkedServiceReference linkedServiceName);
Parameters
LinkedServiceReference linkedServiceName

Linked service reference.

Exceptions
System.ArgumentNullException

linkedServiceName is null.

Properties

Compression

The data compression method used for the file system.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.DatasetCompression Compression { get; set; }
Property Value
DatasetCompression

FileFilter

Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).

Declaration
public object FileFilter { get; set; }
Property Value
System.Object

FileName

The name of the on-premises file system. Type: string (or Expression with resultType string).

Declaration
public object FileName { get; set; }
Property Value
System.Object

FolderPath

The path of the on-premises file system. Type: string (or Expression with resultType string).

Declaration
public object FolderPath { get; set; }
Property Value
System.Object

Format

The format of the files. Please note DatasetStorageFormat is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AvroFormat, JsonFormat, OrcFormat, ParquetFormat and TextFormat.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.DatasetStorageFormat Format { get; set; }
Property Value
DatasetStorageFormat

ModifiedDatetimeEnd

The end of file's modified datetime. Type: string (or Expression with resultType string).

Declaration
public object ModifiedDatetimeEnd { get; set; }
Property Value
System.Object

ModifiedDatetimeStart

The start of file's modified datetime. Type: string (or Expression with resultType string).

Declaration
public object ModifiedDatetimeStart { get; set; }
Property Value
System.Object

Back to top Azure SDK for .NET