Il modello da Cloud Storage a Elasticsearch è una pipeline batch che legge i dati dai file CSV archiviati in un bucket Cloud Storage e li scrive in Elasticsearch come documenti JSON.
Requisiti della pipeline
- Il bucket Cloud Storage deve esistere.
- Deve esistere un host Elasticsearch su un'istanza Google Cloud o su Elasticsearch Cloud accessibile da Dataflow.
- Deve esistere una tabella BigQuery per l'output dell'errore.
Schema CSV
Se i file CSV contengono intestazioni, imposta il parametro del modello containsHeaders
su true
.
In caso contrario, crea un file di schema JSON che descriva i dati. Specifica l'URI Cloud Storage del file di schema nel parametro del modello jsonSchemaPath
. L'esempio seguente mostra uno schema JSON:
[{"name":"id", "type":"text"}, {"name":"age", "type":"integer"}]
In alternativa, puoi fornire una funzione definita dall'utente;utente (UDF) che analizza il testo del file CSV e restituisce i documenti Elasticsearch.
Parametri del modello
Parametri obbligatori
- deadletterTable : la tabella BigQuery a cui inviare gli inserti non riusciti. Ad esempio: progetto-tuo-set-di-dati.nome-tabella.
- inputFileSpec : il pattern del file di Cloud Storage per cercare i file CSV. Esempio: gs://mybucket/test-*.csv.
- connectionUrl : l'URL Elasticsearch nel formato https://hostname:[port]. Se utilizzi Elastic Cloud, specifica il CloudID. Esempio: https://elasticsearch-host:9200.
- apiKey : la chiave API codificata in Base64 da utilizzare per l'autenticazione.
- index : l'indice Elasticsearch a cui vengono inviate le richieste, ad esempio
my-index.
(ad esempio: my-index).
Parametri facoltativi
- inputFormat : formato file di input. Il valore predefinito è CSV.
- containsHeaders : i file CSV di input contengono un record di intestazione (vero/falso). Obbligatorio solo per la lettura di file CSV. Il valore predefinito è: false.
- Delimitatore : il delimitatore di colonna dei file di testo di input. Predefinito: utilizza il delimitatore fornito in csvFormat (ad esempio: ,).
- csvFormat : specifica del formato CSV da utilizzare per l'analisi dei record. Il valore predefinito è: Predefinita. Per maggiori dettagli, visita la pagina https://commons.apache.org/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.html. Devono corrispondere esattamente ai nomi dei formati indicati alla pagina https://commons.apache.org/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.Predefined.html.
- jsonSchemaPath : il percorso dello schema JSON. Il valore predefinito è null. ad esempio gs://path/to/schema.
- largeNumFiles : imposta questo valore su true se il numero di file è espresso in decine di migliaia. Il valore predefinito è: false.
- csvFileEncoding : il formato di codifica dei caratteri del file CSV. I valori consentiti sono US-ASCII, ISO-8859-1, UTF-8 e UTF-16. Il valore predefinito è UTF-8.
- logDetailedCsvConversionErrors : imposta il valore su true per attivare il logging dettagliato degli errori quando l'analisi CSV non va a buon fine. Tieni presente che ciò potrebbe esporre dati sensibili nei log (ad es. se il file CSV contiene password). Valore predefinito: false.
- elasticsearchUsername : il nome utente Elasticsearch con cui eseguire l'autenticazione. Se specificato, il valore di "apiKey" viene ignorato.
- elasticsearchPassword : la password di Elasticsearch con cui eseguire l'autenticazione. Se specificato, il valore di "apiKey" viene ignorato.
- batchSize : la dimensione del batch in numero di documenti. Il valore predefinito è 1000.
- batchSizeBytes : la dimensione del batch in numero di byte. Il valore predefinito è 5242880 (5 MB).
- maxRetryAttempts : numero massimo di nuovi tentativi. Deve essere maggiore di zero. Il valore predefinito è: nessun nuovo tentativo.
- maxRetryDuration : la durata massima per i nuovi tentativi in millisecondi. Deve essere maggiore di zero. Il valore predefinito è: nessun nuovo tentativo.
- propertyAsIndex : la proprietà nel documento indicizzato il cui valore specifica i metadati
_index
da includere nel documento nelle richieste collettive. Ha la precedenza su una funzione definita dall'utente_index
. Il valore predefinito è: nessuno. - javaScriptIndexFnGcsPath : il percorso Cloud Storage dell'origine della funzione JavaScript definita dall'utente per una funzione che specifica i metadati
_index
da includere nel documento nelle richieste in blocco. Il valore predefinito è: nessuno. - javaScriptIndexFnName : il nome della funzione JavaScript della funzione definita dall'utente che specifica i metadati
_index
da includere nel documento nelle richieste collettive. Il valore predefinito è: nessuno. - propertyAsId : una proprietà nel documento indicizzato il cui valore specifica i metadati
_id
da includere nel documento nelle richieste collettive. Ha la precedenza su una funzione definita dall'utente_id
. Il valore predefinito è: nessuno. - javaScriptIdFnGcsPath : il percorso Cloud Storage della sorgente della funzione JavaScript definita dall'utente per la funzione che specifica i metadati
_id
da includere nel documento nelle richieste in blocco. Il valore predefinito è: nessuno. - javaScriptIdFnName : il nome della funzione JavaScript della funzione definita dall'utente che specifica i metadati
_id
da includere nel documento nelle richieste collettive. Il valore predefinito è: nessuno. - javaScriptTypeFnGcsPath : il percorso Cloud Storage dell'origine della funzione JavaScript definita dall'utente per una funzione che specifica i metadati
_type
da includere con i documenti nelle richieste collettive. Valore predefinito: nessuno. - javaScriptTypeFnName : il nome della funzione JavaScript della funzione definita dall'utente che specifica i metadati
_type
da includere nel documento nelle richieste collettive. Il valore predefinito è: nessuno. - javaScriptIsDeleteFnGcsPath : il percorso Cloud Storage dell'origine della funzione JavaScript definita dall'utente per la funzione che determina se eliminare il documento anziché inserirlo o aggiornarlo. La funzione restituisce un valore stringa di
true
ofalse
. Il valore predefinito è: nessuno. - javaScriptIsDeleteFnName : il nome della funzione JavaScript della funzione definita dall'utente che determina se eliminare il documento anziché inserirlo o aggiornarlo. La funzione restituisce un valore stringa di
true
ofalse
. Il valore predefinito è: nessuno. - usePartialUpdate : indica se utilizzare aggiornamenti parziali (aggiornare anziché creare o indicizzare, consentendo documenti parziali) con richieste Elasticsearch. Il valore predefinito è: false.
- bulkInsertMethod : indica se utilizzare
INDEX
(indice, consente upsert) oCREATE
(creazione, errori su _id duplicati) con richieste collettive Elasticsearch. Il valore predefinito è CREATE. - trustSelfSignedCerts : indica se considerare attendibile il certificato autofirmato o meno. Un'istanza Elasticsearch installata potrebbe avere un certificato autofirmato. Abilita questo valore su True per bypassare la convalida sul certificato SSL. (il valore predefinito è False).
- disableCertificateValidation : se impostato su "true", considera attendibile il certificato SSL autofirmato. Un'istanza di Elasticsearch potrebbe avere un certificato autofirmato. Per ignorare la convalida del certificato, imposta questo parametro su "true". Valore predefinito: false.
- apiKeyKMSEncryptionKey : la chiave Cloud KMS per decriptare la chiave API. Questo parametro deve essere fornito se apiKeySource è impostato su KMS. Se viene fornito questo parametro, la stringa apiKey deve essere passata in modalità criptata. Cripta i parametri utilizzando l'endpoint di crittografia dell'API KMS. Il formato della chiave deve essere projects/{gcp_project}/locations/{key_region}/keyRings/{key_ring}/cryptoKeys/{kms_key_name}. Vedi: https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys/encrypt (ad esempio: projects/your-project-id/locations/global/keyRings/your-keyring/cryptoKeys/your-key-name).
- apiKeySecretId : ID secret di Secret Manager per apiKey. Questo parametro deve essere fornito se apiKeySource è impostato su SECRET_MANAGER. Il formato deve essere projects/{project}/secrets/{secret}/versions/{secret_version}. (ad esempio: projects/tuo-ID-progetto/secret/tuo-secret/versioni/tua-versione-secret).
- apiKeySource : origine della chiave API. Uno tra PLAINTEXT, KMS o SECRET_MANAGER. Questo parametro è obbligatorio se viene utilizzato Secret Manager o KMS. Se apiKeySource è impostato su KMS, è necessario specificare apiKeyKMSEncryptionKey e l'apiKey criptata. Se apiKeySource è impostato su SECRET_MANAGER, è necessario specificare apiKeySecretId. Se apiKeySource è impostato su PLAINTEXT, è necessario specificare apiKey. Il valore predefinito è PLAINTEXT.
- javascriptTextTransformGcsPath : l'URI Cloud Storage del file .js che definisce la funzione JavaScript definita dall'utente da utilizzare. (Esempio: gs://my-bucket/my-udfs/my_file.js).
- javascriptTextTransformFunctionName : il nome della funzione definita dall'utente di JavaScript da utilizzare. Ad esempio, se il codice della funzione JavaScript è
myTransform(inJson) { /*...do stuff...*/ }
, il nome della funzione èmyTransform
. Per esempi di funzioni JavaScript di esempio, consulta gli esempi di funzioni definite dall'utente (https://github.com/GoogleCloudPlatform/DataflowTemplates#udf-examples).
Funzioni definite dall'utente
Questo modello supporta le funzioni definite dall'utente in più punti della pipeline, descritta di seguito. Per ulteriori informazioni, consulta Creare funzioni definite dall'utente per i modelli Dataflow.
Funzione di trasformazione del testo
Trasforma i dati CSV in un documento Elasticsearch.
Parametri del modello:
javascriptTextTransformGcsPath
: l'URI Cloud Storage del file JavaScript.javascriptTextTransformFunctionName
: il nome della funzione JavaScript.
Specifica della funzione:
- Input: una singola riga di un file CSV di input.
- Output: un documento JSON stringato da inserire in Elasticsearch.
Funzione di indice
Restituisce l'indice a cui appartiene il documento.
Parametri del modello:
javaScriptIndexFnGcsPath
: l'URI Cloud Storage del file JavaScript.javaScriptIndexFnName
: il nome della funzione JavaScript.
Specifica della funzione:
- Input: il documento Elasticsearch, serializzato come stringa JSON.
- Output: il valore del campo dei metadati
_index
del documento.
Funzione ID documento
Restituisce l'ID documento.
Parametri del modello:
javaScriptIdFnGcsPath
: l'URI Cloud Storage del file JavaScript.javaScriptIdFnName
: il nome della funzione JavaScript.
Specifica della funzione:
- Input: il documento Elasticsearch, serializzato come stringa JSON.
- Output: il valore del campo dei metadati
_id
del documento.
Funzione di eliminazione documenti
Specifica se eliminare un documento. Per utilizzare questa funzione, imposta la modalità di inserimento
collettivo su INDEX
e fornisci una
funzione ID documento.
Parametri del modello:
javaScriptIsDeleteFnGcsPath
: l'URI Cloud Storage del file JavaScript.javaScriptIsDeleteFnName
: il nome della funzione JavaScript.
Specifica della funzione:
- Input: il documento Elasticsearch, serializzato come stringa JSON.
- Output: restituisci la stringa
"true"
per eliminare il documento o"false"
per eseguire l'upsert del documento.
Funzione di tipo mappatura
Restituisce il tipo di mappatura del documento.
Parametri del modello:
javaScriptTypeFnGcsPath
: l'URI Cloud Storage del file JavaScript.javaScriptTypeFnName
: il nome della funzione JavaScript.
Specifica della funzione:
- Input: il documento Elasticsearch, serializzato come stringa JSON.
- Output: il valore del campo dei metadati
_type
del documento.
Esegui il modello
Console
- Vai alla pagina Crea job da modello di Dataflow. Vai a Crea job da modello
- Nel campo Nome job, inserisci un nome univoco per il job.
- (Facoltativo) Per Endpoint a livello di regione, seleziona un valore dal menu a discesa. La regione predefinita è
us-central1
.Per un elenco delle regioni in cui puoi eseguire un job Dataflow, vedi Località Dataflow.
- Nel menu a discesa Modello Dataflow, seleziona the Cloud Storage to Elasticsearch template.
- Nei campi dei parametri forniti, inserisci i valori dei parametri.
- Fai clic su Esegui job.
gcloud
Nella shell o nel terminale, esegui il modello:
gcloud dataflow flex-template run JOB_NAME \ --project=PROJECT_ID\ --region=REGION_NAME \ --template-file-gcs-location=gs://dataflow-templates-REGION_NAME/VERSION/flex/GCS_to_Elasticsearch \ --parameters \ inputFileSpec=INPUT_FILE_SPEC,\ connectionUrl=CONNECTION_URL,\ apiKey=APIKEY,\ index=INDEX,\ deadletterTable=DEADLETTER_TABLE,\
Sostituisci quanto segue:
PROJECT_ID
: l'ID del progetto Google Cloud in cui vuoi eseguire il job DataflowJOB_NAME
: un nome job univoco a tua sceltaVERSION
: la versione del modello che vuoi utilizzarePuoi utilizzare i seguenti valori:
latest
per utilizzare la versione più recente del modello, disponibile nella cartella padre senza data del bucket: gs://dataflow-templates-REGION_NAME/latest/- il nome della versione, come
2023-09-12-00_RC00
, per utilizzare una versione specifica del modello, che si trova nidificata nella rispettiva cartella padre con data all'interno del bucket: gs://dataflow-templates-REGION_NAME/
REGION_NAME
: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempious-central1
INPUT_FILE_SPEC
: il pattern del tuo file di Cloud Storage.CONNECTION_URL
: il tuo URL Elasticsearch.APIKEY
: la tua chiave API codificata in Base64 per l'autenticazione.INDEX
: il tuo indice Elasticsearch.DEADLETTER_TABLE
: la tua tabella BigQuery.
API
Per eseguire il modello utilizzando l'API REST, invia una richiesta POST HTTP. Per maggiori informazioni sull'API e sui relativi ambiti di autorizzazione, consulta projects.templates.launch
.
POST https://dataflow.googleapis.com/v1b3/projects/PROJECT_ID/locations/LOCATION/flexTemplates:launch { "launch_parameter": { "jobName": "JOB_NAME", "parameters": { "inputFileSpec": "INPUT_FILE_SPEC", "connectionUrl": "CONNECTION_URL", "apiKey": "APIKEY", "index": "INDEX", "deadletterTable": "DEADLETTER_TABLE" }, "containerSpecGcsPath": "gs://dataflow-templates-LOCATION/VERSION/flex/GCS_to_Elasticsearch", } }
Sostituisci quanto segue:
PROJECT_ID
: l'ID del progetto Google Cloud in cui vuoi eseguire il job DataflowJOB_NAME
: un nome job univoco a tua sceltaVERSION
: la versione del modello che vuoi utilizzarePuoi utilizzare i seguenti valori:
latest
per utilizzare la versione più recente del modello, disponibile nella cartella padre senza data del bucket: gs://dataflow-templates-REGION_NAME/latest/- il nome della versione, come
2023-09-12-00_RC00
, per utilizzare una versione specifica del modello, che si trova nidificata nella rispettiva cartella padre con data all'interno del bucket: gs://dataflow-templates-REGION_NAME/
LOCATION
: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempious-central1
INPUT_FILE_SPEC
: il pattern del tuo file di Cloud Storage.CONNECTION_URL
: il tuo URL Elasticsearch.APIKEY
: la tua chiave API codificata in Base64 per l'autenticazione.INDEX
: il tuo indice Elasticsearch.DEADLETTER_TABLE
: la tua tabella BigQuery.
Passaggi successivi
- Scopri di più sui modelli Dataflow.
- Consulta l'elenco dei modelli forniti da Google.