Last updated
One way: SharePoint stays the system of record, and SPSync keeps a read-only copy of your lists current in Azure Data Lake Storage Gen2.
Status: Shipped · product: SPSync for Warehouses & Lakes
Sometimes SharePoint data only needs to exist as files in the lake: no database to run and no warehouse to pay for, just Parquet in a container that Spark, Fabric, Synapse, Power BI and DuckDB already know how to read. The ADLS Gen2 destination does that, and it often sits as the raw layer under a Databricks job or a Fabric Lakehouse shortcut.
Container and sign-in
Point SPSync at a container with an abfss:// URL:
abfss://<container>@<account>.dfs.core.windows.net/<prefix>. Two ways to authenticate:
- SAS token. Put a token with read and write rights in an environment variable and name it in the destination settings. Nothing else on the sync host needs Azure access.
- Azure default credential chain. Leave the token out and SPSync signs in as whatever
identity the host already has, such as the identity of an Azure VM or an
az loginsession.
SPSync uploads through the account’s Blob endpoint, so a standard Blob account may also work; that has been tested against the Azurite emulator only, not a live account. SharePoint to Azure Blob Storage covers the DuckDB export route to a Blob container.
SPSync keeps its merged copy of each list in a local DuckDB state file on the sync host and uploads Parquet from it after each run. Give that file a stable path; losing it means the next run starts again with a full load.
Folder layout
Each table gets a folder in the container, and each run uploads two files into it:
{table}/{run_id}.parquet, one file per run that is never changed afterwards, giving a history of every run;{table}/current.parquet, the latest snapshot, replaced every run.
A help desk list with a Category lookup, an Assignee person column and a multi-choice
Affected systems column produces it_tickets/, it_tickets__affected_systems/ and the
shared sp_users/. Lookups arrive as category_id and category_value, people as
assignee_user_id. Every upload is a full snapshot of the table, deleted items included
with sp_deleted_at set.
A new SharePoint column appears in later files, and earlier files keep the columns they
had. A retyped column is not forked into a _v2 column by the Azure Data Lake Storage Gen2
destination today. Parquet exported from a DuckDB destination to Azure does get a _v2
column (SPSync forks retyped columns on SQL Server, PostgreSQL, MySQL, ClickHouse, Oracle,
SQLite and DuckDB).
Who reads the files
Data engineers swap a Data Factory pipeline or flow
that extracted lists by hand for a scheduled replication. A
data lake across many sources gets SharePoint as one
more set of folders. An analyst reads current.parquet straight into DuckDB. A Power BI
author imports from the folders with the Azure Data Lake Storage connector.
Steps
- Sign in with delegated access, or have an admin register an app with
Sites.Selectedon the sites you need. - Create or choose a storage account with hierarchical namespace enabled, and a container.
- Issue a SAS token, or give the sync host’s identity rights on the container.
- Pick the lists, or the whole site, and start the first run.
- Point Spark, DuckDB, Fabric or Power BI at the folders.
Every run adds one history file per table. On a short schedule over many tables that adds up, so set a lifecycle rule on the container if you do not need every run kept. Storage capacity and transactions are billed by Microsoft.
Desktop, Azure or command line
All three editions run the same engine, write the same tables and use the same licence key, so the choice comes down to who looks after the sync.
Desktop app
For macOS and Windows. Sign in with Microsoft, tick the lists, choose a database and sync from your own machine on the schedule you set. Delegated sign-in needs no admin unless your tenant requires admin consent for apps.
In your Azure
SPSync in your Azure, a managed application for your own subscription, is deployed with you on a call while the Marketplace listing is prepared. Once deployed it is always on, so the sync keeps running with every laptop closed.
Command line
Every replication is a YAML file you can review and commit. Run it from a server, a container or a CI pipeline, and re-run it safely any time.
Frequently asked questions
What file format does SPSync write to Azure Data Lake?
Parquet. Each table gets its own folder holding current.parquet, replaced every run, and one history file per run named for that run.
How does SPSync authenticate to the storage account?
From the command-line tool's config, with a SAS token, or with no token so the Azure default credential chain signs in as whatever identity the sync host has. The desktop app and SPSync in your Azure also accept a full storage connection string with an account key, intended for testing.
Which tools can read the Parquet files SPSync writes?
Anything that reads Parquet from ADLS Gen2, including Spark, DuckDB, Fabric shortcuts, Synapse serverless and Power BI's Azure Data Lake Storage connector.
How are multi-value columns represented as files?
A multi-choice column gets its own folder, one row per value with the parent item's ID and the value's position, the same shape as a child table in a database. Multi-lookup and multi-person values are still being verified on a live tenant.
What happens to items deleted in SharePoint?
The row stays and its sp_deleted_at column is set, so a report can show deleted items or filter them out. To remove the row instead, set deletes: hard on that replication in the command-line tool's YAML config. Runs from the desktop app and from SPSync in your Azure always keep the row.
Talk to us about Azure Data Lake Storage Gen2
SPSync is licensed per installation and per target family, with Standard Support included. Tell us which targets you need and how many machines, and we will size it with you. See how licensing works.
Set it up
Sign in to SharePoint with the SharePoint connection guide, then follow the Azure Data Lake Storage Gen2 setup guide to create the database user and open the connection for Azure Data Lake Storage Gen2. If the connection test fails, the troubleshooting guide lists the errors people hit and what fixes them.
Script it
Everything you can click, you can script. The CLI, YAML config and automation below reproduce this scenario exactly. See the CLI reference.
spsync auth login --client-id 00000000-0000-0000-0000-000000000000
spsync export-config --output replication.yaml --pipeline-name azure_data_lake --prefix azure_data_lake --destination-kind adls-gen2 --connection-string-env SPSYNC_DB_CONNECTION --dataset-name azure_data_lake --client-id 00000000-0000-0000-0000-000000000000 --site-url https://contoso.sharepoint.com/sites/example --all-lists
spsync doctor replication.yaml
spsync run replication.yaml pipeline_name: azure_data_lake
prefix: azure_data_lake
auth:
mode: delegated
client_id: 00000000-0000-0000-0000-000000000000
tenant_id: common
destination:
kind: adls-gen2
connection_string_env: SPSYNC_DB_CONNECTION
dataset_name: azure_data_lake
scopes:
- site_url: https://contoso.sharepoint.com/sites/example
mode: entire_site
reconcile_interval_days: 7
create_reporting_views: false
Cron (Azure Data Lake nightly):
# every night at 02:00
0 2 * * * cd /opt/spsync && SPSYNC_DB_CONNECTION="$(cat /etc/spsync/db.env)" uv run spsync run replication.yaml >> /var/log/spsync/run.log 2>&1 GitHub Actions:
# .github/workflows/spsync-run.yml
name: SPSync
on:
schedule:
- cron: "0 2 * * *"
workflow_dispatch: {}
jobs:
run:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: astral-sh/setup-uv@v3
- run: uv sync
- run: uv run spsync run replication.yaml
env:
SPSYNC_DB_CONNECTION: ${{ secrets.SPSYNC_DB_CONNECTION }}
SPSYNC_LICENCE_KEY: ${{ secrets.SPSYNC_LICENCE_KEY }} Azure DevOps:
# azure-pipelines.yml
schedules:
- cron: "0 2 * * *"
branches: { include: [main] }
always: true
steps:
- script: uv sync
- script: uv run spsync run replication.yaml
env:
SPSYNC_DB_CONNECTION: $(SPSYNC_DB_CONNECTION)
SPSYNC_LICENCE_KEY: $(SPSYNC_LICENCE_KEY) Windows (PowerShell + Task Scheduler):
# Windows Task Scheduler action (see /docs/cli/automation/)
$env:SPSYNC_DB_CONNECTION = (Get-Content C:\spsync\db.env)
uv run spsync run C:\spsync\replication.yaml
schtasks /Create /SC DAILY /ST 02:00 /TN "SPSync" /TR "powershell -File C:\spsync\run.ps1" macOS (launchd):
# ~/Library/LaunchAgents/io.spsync.run.plist, then: launchctl load ~/Library/LaunchAgents/io.spsync.run.plist Secrets (licence key, connection strings) come from the environment, so never write them into the YAML. See scheduling and secrets.