From 1f641b27a496ca64df76083075e95c1fafdbbc7e Mon Sep 17 00:00:00 2001 From: Sam Ansmink Date: Fri, 19 Jul 2024 11:02:07 +0200 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a8a766c..441aedd 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ This extension adds a filesystem abstraction for Azure blob storage to DuckDB. To use it, install latest DuckDB. The extension currently supports only **reads** and **globs**. +## Basics Setup authentication (leverages either Azure CLI or Managed Identity): ```sql CREATE SECRET secret1 ( @@ -13,23 +14,25 @@ CREATE SECRET secret1 ( Then to query a file on azure: ```sql -SELECT count(*) FROM 'azure:///.'; +SELECT count(*) FROM 'az:///.'; ``` Globbing is also supported: ```sql -SELECT count(*) FROM 'azure://dummy_container/*.csv'; +SELECT count(*) FROM 'az://dummy_container/*.csv'; ``` +## Other authentication methods Other authentication options available: -- Connection string +### Connection string ```sql CREATE SECRET secret2 ( TYPE AZURE, CONNECTION_STRING '' ); ``` -- Service Principal (replace `CLIENT_SECRET` with `CLIENT_CERTIFICATE_PATH` to use a client certificate) +### Service Principal +(replace `CLIENT_SECRET` with `CLIENT_CERTIFICATE_PATH` to use a client certificate) ```sql CREATE SECRET azure3 ( TYPE AZURE, @@ -40,7 +43,8 @@ CREATE SECRET azure3 ( ACCOUNT_NAME '⟨storage account name⟩' ); ``` -- Access token (its audience needs to be `https://storage.azure.com`) +### Access token +(its audience needs to be `https://storage.azure.com`) ```sql CREATE SECRET secret4 ( TYPE AZURE, @@ -49,7 +53,7 @@ CREATE SECRET secret4 ( ACCOUNT_NAME '⟨storage account name⟩' ); ``` -- Anonymous +### Anonymous ```sql CREATE SECRET secret5 ( TYPE AZURE,