Share via


FileServerReadSettings Class

Definition

File server read settings.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.FileServerReadSettings+FileServerReadSettingsConverter))]
public class FileServerReadSettings : Azure.Analytics.Synapse.Artifacts.Models.StoreReadSettings
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.FileServerReadSettings+FileServerReadSettingsConverter))>]
type FileServerReadSettings = class
    inherit StoreReadSettings
Public Class FileServerReadSettings
Inherits StoreReadSettings
Inheritance
FileServerReadSettings
Attributes

Constructors

FileServerReadSettings()

Initializes a new instance of FileServerReadSettings.

Properties

AdditionalProperties

Additional Properties.

(Inherited from StoreReadSettings)
DeleteFilesAfterCompletion

Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

EnablePartitionDiscovery

Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).

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).

FileListPath

Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

MaxConcurrentConnections

The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

(Inherited from StoreReadSettings)
ModifiedDatetimeEnd

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

ModifiedDatetimeStart

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

PartitionRootPath

Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

Recursive

If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

WildcardFileName

FileServer wildcardFileName. Type: string (or Expression with resultType string).

WildcardFolderPath

FileServer wildcardFolderPath. Type: string (or Expression with resultType string).

Applies to