read_files funzione con valori di tabella

Si applica a: segno di spunta sì Databricks SQL segno di spunta sì Databricks Runtime 13.3 LTS e versioni successive

Legge i file in un percorso specificato e restituisce i dati in formato tabulare.

Supporta la lettura JSONdei XMLTEXTPARQUETBINARYFILEAVROformati di file , CSVe .ORC Può rilevare automaticamente il formato di file e dedurre uno schema unificato in tutti i file.

Sintassi

read_files(path [, option_key => option_value ] [...])

Argomenti

Questa funzione richiede la chiamata di parametri denominati per le chiavi di opzione.

  • pathSTRING: oggetto con l'URI della posizione dei dati. Supporta la lettura da Azure Data Lake Storage Gen2 ('abfss://'), S3 (s3://) e Google Cloud Storage ('gs://'). Può contenere glob. Per altri dettagli, vedere Individuazione file.
  • option_key: nome dell'opzione da configurare. È necessario usare i backtick (') per le opzioni che contengono punti (.).
  • option_value: espressione costante su cui impostare l'opzione . Accetta valori letterali e funzioni scalari.

Valori restituiti

Tabella costituita dai dati dei file letti nell'oggetto specificato path.

Individuazione file

read_files può leggere un singolo file o leggere i file in una directory specificata. read_files individua tutti i file nella directory specificata in modo ricorsivo, a meno che non venga fornito un GLOB , che indica read_files di ripetere il processo in un modello di directory specifico.

Filtro di directory o file usando modelli GLOB

I modelli Glob possono essere usati per filtrare directory e file quando specificati nel percorso.

Modello Descrizione
? Corrisponde a qualsiasi carattere singolo
* Corrisponde a zero o più caratteri
[abc] Trova la corrispondenza di un singolo carattere del set di caratteri {a,b,c}.
[a-z] Trova la corrispondenza di un singolo carattere dall'intervallo di caratteri {a... z}.
[^a] Trova la corrispondenza di un singolo carattere non incluso nel set di caratteri o nell'intervallo {a}. Si noti che il ^ carattere deve essere immediatamente a destra della parentesi aperta.
{ab,cd} Trova la corrispondenza di una stringa dal set di stringhe {ab, cd}.
{ab,c{de, fh}} Trova la corrispondenza di una stringa dal set di stringhe {ab, cde, cfh}.

read_files usa il globber rigido del caricatore automatico durante l'individuazione dei file con glob. Questa opzione è configurata dall'opzione useStrictGlobber . Quando il globber rigido è disabilitato, le barre finali (/) vengono eliminate e un modello a stella, /*/ ad esempio, può espandersi nell'individuazione di più directory. Vedere gli esempi seguenti per vedere la differenza nel comportamento.

Modello Percorso file Strict globber disabilitato Strict globber abilitato
/a/b /a/b/c/file.txt
/a/b /a/b_dir/c/file.txt No No
/a/b /a/b.txt No No
/a/b/ /a/b.txt No No
/a/*/c/ /a/b/c/file.txt
/a/*/c/ /a/b/c/d/file.txt
/a/*/d/ /a/b/c/d/file.txt No
/a/*/c/ /a/b/x/y/c/file.txt No
/a/*/c /a/b/c_file.txt No
/a/*/c/ /a/b/c_file.txt No
/a/*/c /a/b/cookie/file.txt No
/a/b* /a/b.txt
/a/b* /a/b/file.txt
/a/{0.txt,1.txt} /a/0.txt
/a/*/{0.txt,1.txt} /a/0.txt No No
/a/b/[cde-h]/i/ /a/b/c/i/file.txt

Inferenza dello schema

Lo schema dei file può essere fornito in modo esplicito a read_files con l'opzione schema . Quando lo schema non viene specificato, read_files tenta di dedurre uno schema unificato tra i file individuati, che richiede la lettura di tutti i file, a meno che non venga usata un'istruzione LIMIT . Anche quando si usa una LIMIT query, potrebbe essere letto un set di file di dimensioni maggiori di quello necessario per restituire uno schema più rappresentativo dei dati. Databricks aggiunge automaticamente un'istruzione LIMIT per SELECT le query nei notebook e l'editor SQL se non ne è stato specificato uno.

L'opzione schemaHints può essere usata per correggere i subset dello schema dedotto. Per altri dettagli, vedere Eseguire l'override dell'inferenza dello schema con hint dello schema.

Un rescuedDataColumn oggetto viene fornito per impostazione predefinita per salvare tutti i dati che non corrispondono allo schema. Per altri dettagli, vedere Che cos'è la colonna di dati salvata? È possibile eliminare rescuedDataColumn impostando l'opzione schemaEvolutionMode => 'none'.

Inferenza dello schema di partizione

read_filespuò anche dedurre le colonne di partizionamento se i file vengono archiviati in directory partizionate in stile Hive, ovvero /column_name=column_value/. Se viene specificato , schema le colonne di partizione individuate usano i tipi forniti in schema. Se le colonne di partizione non fanno parte dell'oggetto specificato schema, le colonne di partizione dedotte vengono ignorate.

Se esiste una colonna sia nello schema di partizione che nelle colonne di dati, viene usato il valore letto dal valore della partizione anziché il valore di dati. Se si desidera ignorare i valori provenienti dalla directory e usare la colonna di dati, è possibile fornire l'elenco di colonne di partizione in un elenco delimitato da virgole con l'opzione partitionColumns .

L'opzione partitionColumns può essere usata anche per indicare read_files sulle colonne individuate da includere nello schema dedotto finale. Se si specifica una stringa vuota, tutte le colonne di partizione vengono ignorate.

È schemaHints anche possibile specificare l'opzione per eseguire l'override dello schema dedotto per una colonna di partizione.

I TEXT formati e BINARYFILE hanno uno schema fisso, ma read_files tenta anche di dedurre il partizionamento per questi formati, quando possibile.

Utilizzo nelle tabelle di streaming

read_files può essere usato nelle tabelle di streaming per inserire file in Delta Lake. read_files sfrutta il caricatore automatico quando viene usato in una query di tabella di streaming. È necessario usare la STREAM parola chiave con read_files. Per altri dettagli, vedere Che cos'è il caricatore automatico?

Se usato in una query di streaming, read_files usa un esempio di dati per dedurre lo schema e può evolvere lo schema man mano che elabora più dati. Per altri dettagli, vedere Configurare l'inferenza e l'evoluzione dello schema in Caricamento automatico.

Opzioni

Opzioni standard

Opzione
format

Tipo: String

Formato del file di dati nel percorso di origine. Dedotto automaticamente se non specificato. I valori consentiti includono:

- avro: File Avro
- binaryFile: File Binario
- csv: Leggere un file CSV
- json: File JSON
- orc: file ORC
- parquet: Leggere i file Parquet con Azure Databricks
- text: file di testo
- xml: lettura e scrittura di file XML

Valore predefinito: Nessuno
inferColumnTypes

Tipo: Boolean

Indica se dedurre tipi di colonna esatti quando si sfrutta l'inferenza dello schema. Per impostazione predefinita, le colonne vengono dedotte durante l'inferenza di set di dati JSON e CSV. Per altri dettagli, vedere Inferenza dello schema. Si noti che questo è l'opposto dell'impostazione predefinita di Auto Loader.

Valore predefinito: true
partitionColumns

Tipo: String

Elenco delimitato da virgole di colonne di partizione di stile Hive che si desidera dedurre dalla struttura di directory dei file. Le colonne di partizione dello stile Hive sono coppie chiave-valore combinate da un segno di uguaglianza, ad esempio
<base-path>/a=x/b=1/c=y/file.format. In questo esempio le colonne di partizione sono a, b e c. Per impostazione predefinita, queste colonne verranno aggiunte automaticamente allo schema se si usa l'inferenza dello schema e si fornirà <base-path> per caricare i dati da. Se si specifica uno schema, il caricatore automatico prevede che queste colonne vengano incluse nello schema. Se non si desidera che queste colonne facciano parte dello schema, è possibile specificare "" per ignorare queste colonne. Inoltre, è possibile usare questa opzione quando si vuole dedurre il percorso del file in strutture di directory complesse, come nell'esempio seguente:

<base-path>/year=2022/week=1/file1.csv
<base-path>/year=2022/month=2/day=3/file2.csv
<base-path>/year=2022/month=2/day=4/file3.csv

Specificando cloudFiles.partitionColumns come year,month,day restituirà
year=2022 per file1.csv, ma le colonne month e day saranno null.
month e day verranno analizzati correttamente per file2.csv e file3.csv.

Valore predefinito: Nessuno
schemaHints

Tipo: String

Informazioni sullo schema fornite al caricatore automatico durante l'inferenza dello schema. Vedere hint di schema per maggiori dettagli.

Valore predefinito: Nessuno
useStrictGlobber

Tipo: Boolean

Indica se usare un globber rigoroso che corrisponde al comportamento predefinito di globbing di altre origini file in Apache Spark. Per altri dettagli, vedere Modelli di caricamento dei dati comuni. Disponibile in Databricks Runtime 12.2 LTS e versioni successive. Si noti che si tratta dell'opposto dell'impostazione predefinita per Il caricatore automatico.

Valore predefinito: true

Opzioni generiche

Le opzioni seguenti si applicano a tutti i formati di file.

Opzione
ignoreCorruptFiles

Tipo: Boolean

Indica se ignorare i file danneggiati. Se true, i processi Spark continueranno a essere eseguiti quando si verificano file danneggiati e il contenuto letto verrà comunque restituito. Osservabile come numSkippedCorruptFiles nella
colonna operationMetrics della cronologia di Delta Lake. Disponibile in Databricks Runtime 11.3 LTS e versioni successive.

Valore predefinito: false
ignoreMissingFiles

Tipo: Boolean

Indica se ignorare i file mancanti. Se true, i processi Spark continueranno a essere eseguiti quando vengono rilevati file mancanti e il contenuto letto verrà comunque restituito. Disponibile in Databricks Runtime 11.3 LTS e versioni successive.

Valore predefinito: false (true per COPY INTO)
modifiedAfter

Tipo: Timestamp String, per esempio, 2021-01-01 00:00:00.000000 UTC+0

Timestamp facoltativo per inserire file con un timestamp di modifica dopo il timestamp specificato.

Valore predefinito: Nessuno
modifiedBefore

Tipo: Timestamp String, per esempio, 2021-01-01 00:00:00.000000 UTC+0

Timestamp facoltativo per inserire file con un timestamp di modifica prima del timestamp specificato.

Valore predefinito: Nessuno
pathGlobFilter oppure fileNamePattern

Tipo: String

Un potenziale modello glob da fornire per la scelta dei file. Equivalente a
PATTERN in COPY INTO. fileNamePattern può essere usato in read_files.

Valore predefinito: Nessuno
recursiveFileLookup

Tipo: Boolean

Se ignorare l'inferenza della partizione durante l'inferenza dello schema. Ciò non influisce sui file caricati.

Valore predefinito: false

Opzioni JSON

Opzione
allowBackslashEscapingAnyCharacter

Tipo: Boolean

Indica se consentire alle barre rovesciate di eseguire l'escape di qualsiasi carattere che abbia esito positivo. Se non è abilitata, solo i caratteri elencati in modo esplicito dalla specifica JSON possono essere preceduti da un carattere di escape.

Valore predefinito: false
allowComments

Tipo: Boolean

Indica se consentire o meno l'uso dei commenti di stile Java, C e C++ ('/', '*' e '//' ) all'interno del contenuto analizzato.

Valore predefinito: false
allowNonNumericNumbers

Tipo: Boolean

Indica se consentire il set di token non numerici (NaN) come valori numerici mobili legali.

Valore predefinito: true
allowNumericLeadingZeros

Tipo: Boolean

Indica se consentire ai numeri integrali di iniziare con zeli aggiuntivi (ignorabili), (ad esempio 000001).

Valore predefinito: false
allowSingleQuotes

Tipo: Boolean

Indica se consentire l'uso di virgolette singole (apostrofo, carattere '\') per le stringhe tra virgolette (nomi e valori stringa).

Valore predefinito: true
allowUnquotedControlChars

Tipo: Boolean

Indica se consentire alle stringhe JSON di contenere caratteri di controllo senza caratteri di escape (caratteri ASCII con valore minore di 32, inclusi caratteri di tabulazioni e avanzamento riga) o meno.

Valore predefinito: false
allowUnquotedFieldNames

Tipo: Boolean

Indica se consentire l'uso di nomi di campo senza virgolette (consentiti da JavaScript, ma non dalla specifica JSON).

Valore predefinito: false
badRecordsPath

Tipo: String

Percorso per archiviare i file per registrare le informazioni sui record JSON non validi.

Valore predefinito: Nessuno
columnNameOfCorruptRecord

Tipo: String

Colonna per l'archiviazione di record non validi e non analizzabili. Se l'oggetto per l'analisi mode è impostato su DROPMALFORMED, questa colonna sarà vuota.

Valore predefinito: _corrupt_record
dateFormat

Tipo: String

Formato per l'analisi delle stringhe di data.

Valore predefinito: yyyy-MM-dd
dropFieldIfAllNull

Tipo: Boolean

Indica se ignorare le colonne di tutti i valori Null o matrici e struct vuoti durante l'inferenza dello schema.

Valore predefinito: false
encoding oppure charset

Tipo: String

Nome della codifica dei file JSON. Vedere java.nio.charset.Charset per l'elenco delle opzioni. Non è possibile usare UTF-16 e UTF-32 quando multiline è true.

Valore predefinito: UTF-8
inferTimestamp

Tipo: Boolean

Indica se provare e dedurre stringhe di timestamp come TimestampType. Se impostato su
true, l'inferenza dello schema potrebbe richiedere molto più tempo. È necessario abilitare cloudFiles.inferColumnTypes per l’uso con il caricatore automatico.

Valore predefinito: false
lineSep

Tipo: String

Stringa tra due record JSON consecutivi.

Valore predefinito: nessuno, che copre \r, \r\n e \n
locale

Tipo: String

Un identificatore java.util.Locale. Influenza l'analisi di data, timestamp e decimale predefinita all'interno di JSON.

Valore predefinito: US
mode

Tipo: String

Modalità parser per la gestione di record in formato non valido. Uno di 'PERMISSIVE',
'DROPMALFORMED', o 'FAILFAST'.

Valore predefinito: PERMISSIVE
multiLine

Tipo: Boolean

Indica se i record JSON si estendono su più righe.

Valore predefinito: false
prefersDecimal

Tipo: Boolean

Tenta di dedurre stringhe come DecimalType invece di tipo float o double, quando possibile. È anche necessario usare l'inferenza dello schema, abilitando
inferSchema o usando cloudFiles.inferColumnTypes con il caricatore automatico.

Valore predefinito: false
primitivesAsString

Tipo: Boolean

Indica se dedurre tipi primitivi come numeri e booleani come StringType.

Valore predefinito: false
readerCaseSensitive

Tipo: Boolean

Specifica il comportamento di distinzione tra maiuscole e minuscole quando rescuedDataColumn è abilitato. Se true, salvare le colonne di dati i cui nomi differiscono per maiuscole e minuscole rispetto allo schema; in caso contrario, leggere i dati senza distinzione tra maiuscole e minuscole. Disponibile in Databricks Runtime
13.3 e versioni successive.

Valore predefinito: true
rescuedDataColumn

Tipo: String

Indica se raccogliere tutti i dati che non possono essere analizzati a causa di una mancata corrispondenza del tipo di dati o di una mancata corrispondenza dello schema (inclusa la combinazione di maiuscole e minuscole) in una colonna separata. Questa colonna è inclusa per impostazione predefinita quando si usa il caricatore automatico. Per altre informazioni, vedere Che cos'è la colonna di dati salvata?

Valore predefinito: Nessuno
singleVariantColumn

Tipo: String

Indica se inserire l'intero documento JSON, analizzato in una singola colonna Variant con la stringa specificata come nome della colonna. Se disabilitato, i campi JSON verranno inseriti nelle proprie colonne.

Valore predefinito: Nessuno
timestampFormat

Tipo: String

Formato per l'analisi delle stringhe di timestamp.

Valore predefinito: yyyy-MM-dd'T'HH:mm:ss[.SSS][XXX]
timeZone

Tipo: String

Oggetto java.time.ZoneId da utilizzare durante l'analisi di timestamp e date.

Valore predefinito: Nessuno

Opzioni CSV

Opzione
badRecordsPath

Tipo: String

Percorso in cui archiviare i file per registrare le informazioni sui record CSV non validi.

Valore predefinito: Nessuno
charToEscapeQuoteEscaping

Tipo: Char

Carattere utilizzato per eseguire l'escape del carattere utilizzato per l'escape delle virgolette. Ad esempio, per i seguenti record [ " a\\", b ]:

- Se il carattere per saltare il '\' è indefinito, il record non verrà analizzato. Il parser leggerà i caratteri: [a],[\],["],[,],[ ],[b] e genererà un errore perché non riesce a trovare un'virgoletta di chiusura.
- Se il carattere per saltare il '\' è definito come '\', il record verrà letto con 2 valori: [a\] e [b].

Valore predefinito: '\0'
columnNameOfCorruptRecord

> [! NOTA] >> Supportato per il caricatore automatico. Non supportato per COPY INTO.

Tipo: String

Colonna per l'archiviazione di record non validi e non analizzabili. Se l'oggetto per l'analisi mode è impostato su DROPMALFORMED, questa colonna sarà vuota.

Valore predefinito: _corrupt_record
comment

Tipo: Char

Definisce il carattere che rappresenta un commento di riga quando viene trovato all'inizio di una riga di testo. Usare '\0' per disabilitare l'ignoramento dei commenti.

Valore predefinito: '\u0000'
dateFormat

Tipo: String

Formato per l'analisi delle stringhe di data.

Valore predefinito: yyyy-MM-dd
emptyValue

Tipo: String

Rappresentazione in forma di stringa di un valore di vuoto.

Valore predefinito: ""
encoding oppure charset

Tipo: String

Nome della codifica dei file CSV. Vederejava.nio.charset.Charset per l'elenco delle opzioni. UTF-16 e UTF-32 non possono essere usati quando multiline è true.

Valore predefinito: UTF-8
enforceSchema

Tipo: Boolean

Indica se applicare forzatamente lo schema specificato o dedotto ai file CSV. Se l'opzione è abilitata, le intestazioni dei file CSV vengono ignorate. Questa opzione viene ignorata per impostazione predefinita quando si usa il caricatore automatico per salvare i dati e consentire l'evoluzione dello schema.

Valore predefinito: true
escape

Tipo: Char

Carattere di escape da utilizzare durante l'analisi dei dati.

Valore predefinito: '\'
header

Tipo: Boolean

Indica se i file CSV contengono un'intestazione. Il caricatore automatico presuppone che i file abbiano intestazioni durante l'inferenza dello schema.

Valore predefinito: false
ignoreLeadingWhiteSpace

Tipo: Boolean

Indica se ignorare gli spazi vuoti iniziali per ogni valore analizzato.

Valore predefinito: false
ignoreTrailingWhiteSpace

Tipo: Boolean

Indica se ignorare gli spazi vuoti finali per ogni valore analizzato.

Valore predefinito: false
inferSchema

Tipo: Boolean

Indica se dedurre i tipi di dati dei record CSV analizzati o per presupporre che tutte le colonne siano di StringType. Richiede un passaggio aggiuntivo sui dati se impostato su true. Per il caricatore automatico, usare cloudFiles.inferColumnTypes invece.

Valore predefinito: false
lineSep

Tipo: String

Stringa tra due record CSV consecutivi.

Valore predefinito: nessuno, che copre \r, \r\n e \n
locale

Tipo: String

Un identificatore java.util.Locale. Influenza l'analisi di data, timestamp e decimale predefinita all'interno del file CSV.

Valore predefinito: US
maxCharsPerColumn

Tipo: Int

Numero massimo di caratteri previsti da un valore da analizzare. Può essere usato per evitare errori di memoria. Il valore predefinito è -1, ovvero illimitato.

Valore predefinito: -1
maxColumns

Tipo: Int

Limite rigido del numero di colonne che un record può avere.

Valore predefinito: 20480
mergeSchema

Tipo: Boolean

Indica se dedurre lo schema tra più file e unire lo schema di ogni file. Abilitato per impostazione predefinita per il caricatore automatico durante l'inferenza dello schema.

Valore predefinito: false
mode

Tipo: String

Modalità parser per la gestione di record in formato non valido. Uno di 'PERMISSIVE',
'DROPMALFORMED' e 'FAILFAST'.

Valore predefinito: PERMISSIVE
multiLine

Tipo: Boolean

Indica se i record CSV si estendono su più righe.

Valore predefinito: false
nanValue

Tipo: String

Rappresentazione di stringa di un valore non numerico durante l'analisi delle colonne FloatType e DoubleType.

Valore predefinito: "NaN"
negativeInf

Tipo: String

Rappresentazione di stringa dell'infinito negativo durante l'analisi delle colonne FloatType e DoubleType.

Valore predefinito: "-Inf"
nullValue

Tipo: String

Rappresentazione in forma di stringa del valore null.

Valore predefinito: ""
parserCaseSensitive (deprecato)

Tipo: Boolean

Durante la lettura dei file, se allineare le colonne dichiarate nell'intestazione con la distinzione tra maiuscole e minuscole dello schema. Questa opzione è true per impostazione predefinita per il caricatore automatico. Le colonne che differiscono per caso verranno salvate nel rescuedDataColumn se abilitato. Questa opzione è stata deprecata a favore di readerCaseSensitive.

Valore predefinito: false
positiveInf

Tipo: String

Rappresentazione di stringa dell'infinito positivo durante l'analisi delle colonne FloatType e DoubleType.

Valore predefinito: "Inf"
preferDate

Tipo: Boolean

Tenta di dedurre stringhe come date anziché timestamp, quando possibile. È anche necessario usare l'inferenza dello schema, abilitando inferSchema o usando
cloudFiles.inferColumnTypes con caricatore automatico.

Valore predefinito: true
quote

Tipo: Char

Carattere utilizzato per l'escape dei valori in cui il delimitatore di campo fa parte del valore.

Valore predefinito: "
readerCaseSensitive

Tipo: Boolean

Specifica il comportamento di distinzione tra maiuscole e minuscole quando rescuedDataColumn è abilitato. Se true, salvare le colonne di dati i cui nomi differiscono per maiuscole e minuscole rispetto allo schema; in caso contrario, leggere i dati senza distinzione tra maiuscole e minuscole.

Valore predefinito: true
rescuedDataColumn

Tipo: String

Indica se raccogliere tutti i dati che non possono essere analizzati a causa di: mancata corrispondenza del tipo di dati e mancata corrispondenza dello schema (incluse le maiuscole) in una colonna separata. Questa colonna è inclusa per impostazione predefinita quando si usa il caricatore automatico. Per altri dettagli, fare riferimento a Che cos'è la colonna di dati salvata?.

Valore predefinito: Nessuno
sep oppure delimiter

Tipo: String

Stringa separatore tra le colonne.

Valore predefinito: ","
skipRows

Tipo: Int

Numero di righe dall'inizio del file CSV che devono essere ignorate (incluse le righe commentate e vuote). Se header è true, l'intestazione sarà la prima riga non ignorata e non commentata.

Valore predefinito: 0
timestampFormat

Tipo: String

Formato per l'analisi delle stringhe di timestamp.

Valore predefinito: yyyy-MM-dd'T'HH:mm:ss[.SSS][XXX]
timeZone

Tipo: String

Oggetto java.time.ZoneId da utilizzare durante l'analisi di timestamp e date.

Valore predefinito: Nessuno
unescapedQuoteHandling

Tipo: String

Strategia per la gestione delle virgolette senza caratteri di escape. Opzioni consentite:

- STOP_AT_CLOSING_QUOTE: se nell'input vengono trovate virgolette senza caratteri di escape, accumulare il carattere di virgolette e continuare a analizzare il valore come valore tra virgolette, fino a quando non viene trovata una virgoletta di chiusura.
- BACK_TO_DELIMITER: se nell'input vengono trovate virgolette senza caratteri di escape, considerare il valore come valore senza virgolette. In questo modo il parser accumula tutti i caratteri del valore analizzato corrente fino a quando non viene trovato il delimitatore definito da sep. Se non viene trovato alcun delimitatore nel valore, il parser continuerà ad accumulare caratteri dall'input fino a quando non viene trovato un delimitatore o una terminazione di riga.
- STOP_AT_DELIMITER: se nell'input vengono trovate virgolette senza caratteri di escape, considerare il valore come valore senza virgolette. In questo modo il parser accumula tutti i caratteri fino a quando il delimitatore definito da sep o una fine di riga viene trovata nell'input.
- SKIP_VALUE: se nell'input vengono trovate virgolette senza caratteri di escape, il contenuto analizzato per il valore specificato verrà ignorato (fino a quando non viene trovato il delimitatore successivo) e il valore impostato in nullValue verrà generato.
- RAISE_ERROR: se nell'input vengono trovate virgolette senza caratteri di escape,
TextParsingException verrà generata.

Valore predefinito: STOP_AT_DELIMITER

Opzioni XML

Opzione Descrizione Scope
rowTag Tag di riga dei file XML da considerare come riga. Nell'esempio XML <books> <book><book>...<books>, il valore appropriato è book. Si tratta di un'opzione obbligatoria. letti
samplingRatio Definisce una frazione di righe utilizzate per l'inferenza dello schema. Le funzioni predefinite XML ignorano questa opzione. Impostazione predefinita: 1.0. letti
excludeAttribute Indica se escludere gli attributi negli elementi. Impostazione predefinita: false. letti
mode Modalità per gestire i record danneggiati durante l'analisi.

PERMISSIVE: per i record danneggiati, inserisce la stringa in formato non valido in un campo configurato da columnNameOfCorruptRecord e imposta i campi in formato non valido su null. Per mantenere i record danneggiati, è possibile impostare un campo di tipo string denominato columnNameOfCorruptRecord in uno schema definito dall'utente. Se il campo non è presente in uno schema, i record danneggiati vengono eliminati durante l'analisi. Quando si deduce uno schema, il parser aggiunge in modo implicito un campo columnNameOfCorruptRecord in uno schema di output.

DROPMALFORMED: ignora i record danneggiati. Questa modalità non è supportata per le funzioni predefinite XML.

FAILFAST: genera un'eccezione quando il parser soddisfa i record danneggiati.
letti
inferSchema Se true, tenta di dedurre un tipo appropriato per ogni colonna DataFrame risultante. Se false, tutte le colonne risultanti sono di tipo string. Impostazione predefinita:
true. Le funzioni predefinite XML ignorano questa opzione.
letti
columnNameOfCorruptRecord Consente di rinominare il nuovo campo contenente una stringa in formato non valido creata dalla
modalità PERMISSIVE. Impostazione predefinita: spark.sql.columnNameOfCorruptRecord.
letti
attributePrefix Prefisso per gli attributi per distinguere gli attributi dagli elementi. Questo sarà il prefisso per i nomi dei campi. Il valore predefinito è _. Può essere vuoto per la lettura del codice XML, ma non per la scrittura. lettura, scrittura
valueTag Tag utilizzato per i dati di tipo carattere all'interno di elementi che dispongono anche di attributi o elementi figlio. L'utente può specificare il campo valueTag nello schema oppure verrà aggiunto automaticamente durante l'inferenza dello schema quando i dati di tipo carattere sono presenti in elementi con altri elementi o attributi. Impostazione predefinita: _VALUE lettura, scrittura
encoding Per la lettura, decodifica i file XML in base al tipo di codifica specificato. Per la scrittura, specifica la codifica (charset) dei file XML salvati. Le funzioni predefinite XML ignorano questa opzione. Impostazione predefinita: UTF-8. lettura, scrittura
ignoreSurroundingSpaces Definisce se gli spazi vuoti circostanti dai valori letti devono essere ignorati. Impostazione predefinita: true. I dati di tipo carattere solo spazi vuoti vengono ignorati. letti
rowValidationXSDPath Percorso di un file XSD facoltativo utilizzato per convalidare il codice XML per ogni riga singolarmente. Le righe che non riescono a convalidare vengono considerate come gli errori di analisi come sopra. L'XSD non influisce in caso contrario sullo schema fornito o dedotto. letti
ignoreNamespace Se true, i prefissi degli spazi dei nomi sugli elementi e gli attributi XML vengono ignorati. I tag <abc:author> e <def:author>, ad esempio, vengono considerati come se entrambi siano solo <author>. Gli spazi dei nomi non possono essere ignorati nell'elemento rowTag, ma solo i relativi elementi figlio di lettura. L'analisi XML non è compatibile con lo spazio dei nomi anche se false. Impostazione predefinita: false. letti
timestampFormat Stringa di formato timestamp personalizzata che segue il formato di modello datetime. Questo vale per il tipo timestamp. Impostazione predefinita: yyyy-MM-dd'T'HH:mm:ss[.SSS][XXX]. lettura, scrittura
timestampNTZFormat Stringa di formato personalizzata per timestamp senza fuso orario che segue il formato del modello datetime. Questo vale per il tipo TimestampNTZType. Impostazione predefinita:
yyyy-MM-dd'T'HH:mm:ss[.SSS]
lettura, scrittura
dateFormat La stringa dei formati di data personalizzati seguono i formati del modello datetime. Questo vale per il tipo di dati. Impostazione predefinita: yyyy-MM-dd. lettura, scrittura
locale Imposta le impostazioni locali come tag di lingua in formato IETF BCP 47. Ad esempio, locale viene usato durante l'analisi di date e timestamp. Impostazione predefinita: en-US. letti
rootTag Tag radice dei file XML. Per esempio, in <books> <book><book>...</books>, il valore appropriato è books. È possibile includere attributi di base specificando un valore come books foo="bar". Impostazione predefinita: ROWS. write
declaration Contenuto della dichiarazione XML da scrivere all'inizio di ogni file XML di output, prima di rootTag. Ad esempio, un valore di foo causa la scrittura di <?xml foo?>. Impostare su una stringa vuota da eliminare. Impostazione predefinita: version="1.0"
encoding="UTF-8" standalone="yes".
write
arrayElementName Nome dell'elemento XML che racchiude ogni elemento di una colonna con valori di matrice durante la scrittura. Impostazione predefinita: item. write
nullValue Imposta la rappresentazione in forma di stringa del valore null. Valore predefinito: stringa null. Quando si tratta di null, il parser non scrive attributi ed elementi per i campi. lettura, scrittura
compression Codice di compressione da usare per il salvataggio nel file. Può trattarsi di uno dei nomi abbreviati senza distinzione tra maiuscole e minuscole note (none, bzip2, gzip,lz4, snappy e
deflate). Le funzioni predefinite XML ignorano questa opzione. Impostazione predefinita: none.
write
validateName Se true, genera un errore in caso di errore di convalida del nome dell'elemento XML. Ad esempio, i nomi dei campi SQL possono avere spazi, ma i nomi degli elementi XML non possono. Impostazione predefinita:
true.
write
readerCaseSensitive Specifica il comportamento di distinzione tra maiuscole e minuscole quando rescuedDataColumn è abilitato. Se true, salvare le colonne di dati i cui nomi differiscono per maiuscole e minuscole rispetto allo schema; in caso contrario, leggere i dati senza distinzione tra maiuscole e minuscole. Impostazione predefinita: true. letti
rescuedDataColumn Indica se raccogliere tutti i dati che non possono essere analizzati a causa di una mancata corrispondenza del tipo di dati e della mancata corrispondenza dello schema (inclusa la combinazione di maiuscole e minuscole) in una colonna separata. Questa colonna è inclusa per impostazione predefinita quando si usa il caricatore automatico. Per altri dettagli, vedere Che cos'è la colonna di dati salvata?. Impostazione predefinita: nessuna. letti

Opzioni PARQUET

Opzione
datetimeRebaseMode

Tipo: String

Controlla la ribasamento dei valori DATE e TIMESTAMP tra i calendari gregoriani Julian e Proleptic. Valori consentiti: EXCEPTION, LEGACY e
CORRECTED.

Valore predefinito: LEGACY
int96RebaseMode

Tipo: String

Controlla la ribasamento dei valori di timestamp INT96 tra i calendari gregoriani Julian e Proleptic. Valori consentiti: EXCEPTION, LEGACY e
CORRECTED.

Valore predefinito: LEGACY
mergeSchema

Tipo: Boolean

Indica se dedurre lo schema tra più file e unire lo schema di ogni file.

Valore predefinito: false
readerCaseSensitive

Tipo: Boolean

Specifica il comportamento di distinzione tra maiuscole e minuscole quando rescuedDataColumn è abilitato. Se true, salvare le colonne di dati i cui nomi differiscono per maiuscole e minuscole rispetto allo schema; in caso contrario, leggere i dati senza distinzione tra maiuscole e minuscole.

Valore predefinito: true
rescuedDataColumn

Tipo: String

Indica se raccogliere tutti i dati che non possono essere analizzati a causa di: mancata corrispondenza del tipo di dati e mancata corrispondenza dello schema (incluse le maiuscole) in una colonna separata. Questa colonna è inclusa per impostazione predefinita quando si usa il caricatore automatico. Per altri dettagli, fare riferimento a Che cos'è la colonna di dati salvata?.

Valore predefinito: Nessuno

Opzioni AVRO

Opzione
avroSchema

Tipo: String

Schema facoltativo fornito da un utente in formato Avro. Quando si legge Avro, questa opzione può essere impostata su uno schema evoluto, compatibile ma diverso con lo schema Avro effettivo. Lo schema di deserializzazione sarà coerente con lo schema evoluto. Ad esempio, se si imposta uno schema evoluto contenente una colonna aggiuntiva con un valore predefinito, il risultato di lettura conterrà anche la nuova colonna.

Valore predefinito: Nessuno
datetimeRebaseMode

Tipo: String

Controlla la ribasamento dei valori DATE e TIMESTAMP tra i calendari gregoriani Julian e Proleptic. Valori consentiti: EXCEPTION, LEGACY e
CORRECTED.

Valore predefinito: LEGACY
mergeSchema

Tipo: Boolean

Indica se dedurre lo schema tra più file e unire lo schema di ogni file.
mergeSchema per Avro non rilassare i tipi di dati.

Valore predefinito: false
readerCaseSensitive

Tipo: Boolean

Specifica il comportamento di distinzione tra maiuscole e minuscole quando rescuedDataColumn è abilitato. Se true, salvare le colonne di dati i cui nomi differiscono per maiuscole e minuscole rispetto allo schema; in caso contrario, leggere i dati senza distinzione tra maiuscole e minuscole.

Valore predefinito: true
rescuedDataColumn

Tipo: String

Indica se raccogliere tutti i dati che non possono essere analizzati a causa di: mancata corrispondenza del tipo di dati e mancata corrispondenza dello schema (incluse le maiuscole) in una colonna separata. Questa colonna è inclusa per impostazione predefinita quando si usa il caricatore automatico. Per altri dettagli, fare riferimento a Che cos'è la colonna di dati salvata?.

Valore predefinito: Nessuno

Opzioni BINARYFILE

I file binari non dispongono di opzioni di configurazione aggiuntive.

Opzioni TEXT

Opzione
encoding

Tipo: String

Nome della codifica dei file TEXT. Vedere java.nio.charset.Charset per l'elenco delle opzioni.

Valore predefinito: UTF-8
lineSep

Tipo: String

Stringa tra due record TEXT consecutivi.

Valore predefinito: nessuno, che copre \r, \r\n e \n
wholeText

Tipo: Boolean

Indica se leggere un file come singolo record.

Valore predefinito: false

Opzioni ORC

Opzione
mergeSchema

Tipo: Boolean

Indica se dedurre lo schema tra più file e unire lo schema di ogni file.

Valore predefinito: false

Opzioni di streaming

Queste opzioni si applicano quando si usa read_files all'interno di una tabella di streaming o di una query di streaming.

Opzione
allowOverwrites

Tipo: Boolean

Se rielaborare i file modificati dopo l'individuazione. L'ultima versione disponibile del file verrà elaborata durante un aggiornamento se è stata modificata dopo l'ora di inizio dell'ultima query di aggiornamento completata.

Valore predefinito: false
includeExistingFiles

Tipo: Boolean

Indica se includere file esistenti nel percorso di input di elaborazione del flusso o elaborare solo i nuovi file in arrivo dopo l'installazione iniziale. Questa opzione viene valutata solo quando si avvia un flusso per la prima volta. La modifica di questa opzione dopo il riavvio del flusso non ha alcun effetto.

Valore predefinito: true
maxBytesPerTrigger

Tipo: Byte String

Numero massimo di nuovi byte da elaborare in ogni trigger. È possibile specificare una stringa di byte, ad esempio 10g per limitare ogni microbatch a 10 GB di dati. Questo è un massimo morbido. Se sono presenti file di 3 GB ciascuno, Azure Databricks elabora 12 GB in un microbatch. Se usato insieme a maxFilesPerTrigger, Azure Databricks usa fino al limite inferiore di maxFilesPerTrigger o maxBytesPerTrigger, a qualsiasi valore raggiunto per primo.

Nota: per le tabelle di streaming create in sql warehouse serverless, questa opzione e maxFilesPerTrigger non deve essere impostata per sfruttare il controllo di ammissione dinamico, che viene ridimensionato in base alle dimensioni del carico di lavoro e alle risorse di calcolo serverless per offrire la latenza e le prestazioni migliori.

Valore predefinito: Nessuno
maxFilesPerTrigger

Tipo: Integer

Numero massimo di nuovi file da elaborare in ogni trigger. Se usato insieme a maxBytesPerTrigger, Azure Databricks usa fino al limite inferiore di maxFilesPerTrigger o maxBytesPerTrigger, a qualsiasi valore raggiunto per primo.

Nota: per le tabelle di streaming create in sql warehouse serverless, questa opzione e maxBytesPerTrigger non deve essere impostata per sfruttare il controllo di ammissione dinamico, che viene ridimensionato in base alle dimensioni del carico di lavoro e alle risorse di calcolo serverless per offrire la latenza e le prestazioni migliori.

Valore predefinito: 1000
schemaEvolutionMode

Tipo: String

La modalità per l'evoluzione dello schema man mano che vengono individuate nuove colonne nei dati. Per impostazione predefinita, le colonne vengono dedotte come stringhe durante l'inferenza di set di dati JSON. Per altri dettagli, vedere Evoluzione dello schema. Questa opzione non si applica ai text file e binaryFile .

Valore predefinito: "addNewColumns" quando non viene fornito uno schema.
In caso contrario, "none".
schemaLocation

Tipo: String

Percorso in cui archiviare lo schema dedotto e le modifiche successive. Per altri dettagli, vedere Inferenza dello schema. Il percorso dello schema non è necessario quando viene usato in una query di tabella di streaming.

Valore predefinito: Nessuno

Esempi

-- Reads the files available in the given path. Auto-detects the format and schema of the data.
> SELECT * FROM read_files('abfss://container@storageAccount.dfs.core.windows.net/base/path');

-- Reads the headerless CSV files in the given path with the provided schema.
> SELECT * FROM read_files(
    's3://bucket/path',
    format => 'csv',
    schema => 'id int, ts timestamp, event string');

-- Infers the schema of CSV files with headers. Because the schema is not provided,
-- the CSV files are assumed to have headers.
> SELECT * FROM read_files(
    's3://bucket/path',
    format => 'csv')

-- Reads files that have a csv suffix.
> SELECT * FROM read_files('s3://bucket/path/*.csv')

-- Reads a single JSON file
> SELECT * FROM read_files(
    'abfss://container@storageAccount.dfs.core.windows.net/path/single.json')

-- Reads JSON files and overrides the data type of the column `id` to integer.
> SELECT * FROM read_files(
    's3://bucket/path',
    format => 'json',
    schemaHints => 'id int')

-- Reads files that have been uploaded or modified yesterday.
> SELECT * FROM read_files(
    'gs://my-bucket/avroData',
    modifiedAfter => date_sub(current_date(), 1),
    modifiedBefore => current_date())

-- Creates a Delta table and stores the source file path as part of the data
> CREATE TABLE my_avro_data
  AS SELECT *, _metadata.file_path
  FROM read_files('gs://my-bucket/avroData')

-- Creates a streaming table that processes files that appear only after the table's creation.
-- The table will most likely be empty (if there's no clock skew) after being first created,
-- and future refreshes will bring new data in.
> CREATE OR REFRESH STREAMING TABLE avro_data
  AS SELECT * FROM STREAM read_files('gs://my-bucket/avroData', includeExistingFiles => false);