Skip to main content

SQLite

This connector materializes Flow collections into an ephemeral SQLite database. Note that this connector is for demo and sandbox purposes, and if the connector is restarted for any reason, the data materialized up to that point will be lost in the materialization (your collection will stay in-tact and your other materializations will have the data as normal).

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/materialize-sqlite:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

Prerequisites

To use this connector, you'll need:

  • At least one Flow collection

Configuration

This materialization requires no configuration, and all you need to do is choose a collection to materialize.

Properties

Bindings

PropertyTitleDescriptionTypeRequired/Default
/tableTableTable name to materialize to. It will be created by the connector, unless the connector has previously created it.stringRequired

Sample

materializations:
${PREFIX}/${mat_name}:
endpoint:
connector:
image: ghcr.io/estuary/materialize-sqlite:dev
config: {}
bindings:
- resource:
table: ${TABLE_NAME}
source: ${PREFIX}/${COLLECTION_NAME}

Delta updates

This connector does not support delta updates at the moment.

Reserved words

SQLite has a list of reserved words that must be quoted in order to be used as an identifier. Flow considers all the reserved words that are marked as "reserved" in any of the columns in the official SQlite documentation.

These reserve words are listed in the table below. Flow automatically quotes fields that are in this list.

Reserved words
abortintersect
actioninto
addis
afterisnull
alljoin
alterkey
alwayslast
analyzeleft
andlike
aslimit
ascmatch
attachmaterialized
autoincrementnatural
beforeno
beginnot
betweennothing
bynotnull
cascadenull
casenulls
castof
checkoffset
collateon
columnor
commitorder
conflictothers
constraintouter
createover
crosspartition
currentplan
current_datepragma
current_timepreceding
current_timestampprimary
databasequery
defaultraise
deferrablerange
deferredrecursive
deletereferences
descregexp
detachreindex
distinctrelease
dorename
dropreplace
eachrestrict
elsereturning
endright
escaperollback
exceptrow
excluderows
exclusivesavepoint
existsselect
explainset
failtable
filtertemp
firsttemporary
followingthen
forties
foreignto
fromtransaction
fulltrigger
generatedunbounded
globunion
groupunique
groupsupdate
havingusing
ifvacuum
ignorevalues
immediateview
invirtual
indexwhen
indexedwhere
initiallywindow
innerwith
insertwithout
instead