Liking cljdoc? Tell your friends :D

supabase.storage.analytics

Analytics buckets (Iceberg tables) against Supabase Storage.

Provides analytics bucket CRUD (create, list, delete) plus catalog-info, which returns the connection details needed to point an Iceberg REST catalog client at a bucket. These are project-level operations and take the client directly.

Public alpha: this API is part of a public alpha release and may not be available to your account type.

Example

(require '[supabase.core.client :as client]
         '[supabase.storage.analytics :as analytics])

(def c (client/make-client "https://abc.supabase.co" "anon-key"))

(analytics/create-bucket c "analytics-data")
(analytics/list-buckets c {:limit 10 :sort-column :created-at
                           :sort-order :desc})
(analytics/catalog-info c)

Each function returns {:status :body :headers} on success or an anomaly map on failure. Endpoints live under {storage-url}/iceberg. See https://supabase.com/docs/reference/javascript/storage-analytics-api

Analytics buckets (Iceberg tables) against Supabase Storage.

Provides analytics bucket CRUD (create, list, delete) plus
`catalog-info`, which returns the connection details needed to point
an Iceberg REST catalog client at a bucket. These are project-level
operations and take the client directly.

Public alpha: this API is part of a public alpha release and may not
be available to your account type.

## Example

    (require '[supabase.core.client :as client]
             '[supabase.storage.analytics :as analytics])

    (def c (client/make-client "https://abc.supabase.co" "anon-key"))

    (analytics/create-bucket c "analytics-data")
    (analytics/list-buckets c {:limit 10 :sort-column :created-at
                               :sort-order :desc})
    (analytics/catalog-info c)

Each function returns `{:status :body :headers}` on success or an
anomaly map on failure. Endpoints live under `{storage-url}/iceberg`.
See https://supabase.com/docs/reference/javascript/storage-analytics-api
raw docstring

catalog-infoclj

(catalog-info client)

Returns everything needed to point an Iceberg REST catalog client at this project's analytics buckets: the catalog base URL and the auth headers (authorization and apikey).

This is the analog of the JS client's from/catalog accessor, minus bundling a catalog library: pass the returned :url and :headers to whatever Iceberg REST catalog client you use. The bucket name maps to the Iceberg warehouse parameter.

Pure: performs no I/O.

Returns everything needed to point an Iceberg REST catalog client at
this project's analytics buckets: the catalog base URL and the auth
headers (`authorization` and `apikey`).

This is the analog of the JS client's `from`/catalog accessor, minus
bundling a catalog library: pass the returned `:url` and `:headers` to
whatever Iceberg REST catalog client you use. The bucket name maps to
the Iceberg warehouse parameter.

Pure: performs no I/O.
sourceraw docstring

create-bucketclj

(create-bucket client name)

Creates an analytics bucket named name. Analytics buckets are optimized for analytical queries via Apache Iceberg tables.

Public alpha: this API is part of a public alpha release and may not be available to your account type.

Creates an analytics bucket named `name`. Analytics buckets are
optimized for analytical queries via Apache Iceberg tables.

Public alpha: this API is part of a public alpha release and may not
be available to your account type.
sourceraw docstring

delete-bucketclj

(delete-bucket client name)

Deletes the analytics bucket name. The bucket must be empty first.

Public alpha: this API is part of a public alpha release and may not be available to your account type.

Deletes the analytics bucket `name`. The bucket must be empty first.

Public alpha: this API is part of a public alpha release and may not
be available to your account type.
sourceraw docstring

list-bucketsclj

(list-buckets client)
(list-buckets client opts)

Lists the analytics buckets in the project.

Options

  • :limit — max buckets to return
  • :offset — number of buckets to skip
  • :sort-column:name, :created-at, or :updated-at
  • :sort-order:asc or :desc
  • :search — substring filter on bucket names

Public alpha: this API is part of a public alpha release and may not be available to your account type.

Lists the analytics buckets in the project.

## Options

* `:limit` — max buckets to return
* `:offset` — number of buckets to skip
* `:sort-column` — `:name`, `:created-at`, or `:updated-at`
* `:sort-order` — `:asc` or `:desc`
* `:search` — substring filter on bucket names

Public alpha: this API is part of a public alpha release and may not
be available to your account type.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close