Liking cljdoc? Tell your friends :D

wagoe.storage.shell.adapters.gcs

Google Cloud Storage adapter.

Implements IFileStorage for storing files in Google Cloud Storage (GCS). Suitable for production deployments on Google Cloud requiring scalable object storage.

Google Cloud Storage adapter.

Implements IFileStorage for storing files in Google Cloud Storage (GCS).
Suitable for production deployments on Google Cloud requiring scalable
object storage.
raw docstring

wagoe.storage.shell.adapters.image-processor

Java AWT-based image processing implementation.

Implements IImageProcessor using Java's built-in image processing capabilities. No external dependencies required.

Java AWT-based image processing implementation.

Implements IImageProcessor using Java's built-in image processing capabilities.
No external dependencies required.
raw docstring

wagoe.storage.shell.adapters.local

Local filesystem storage adapter.

Implements IFileStorage for storing files on the local filesystem. Suitable for development and single-server deployments.

Local filesystem storage adapter.

Implements IFileStorage for storing files on the local filesystem.
Suitable for development and single-server deployments.
raw docstring

wagoe.storage.shell.adapters.s3

Amazon S3 storage adapter.

Implements IFileStorage for storing files in AWS S3 or S3-compatible services. Suitable for production deployments requiring scalable object storage.

Amazon S3 storage adapter.

Implements IFileStorage for storing files in AWS S3 or S3-compatible services.
Suitable for production deployments requiring scalable object storage.
raw docstring

wagoe.storage.shell.adapters.spool

A streamed file written to a temporary file before it is stored: that gives the length an upload needs up front without holding the file in memory, and leaves nothing stored when the writer fails.

A streamed file written to a temporary file before it is stored: that
gives the length an upload needs up front without holding the file in
memory, and leaves nothing stored when the writer fails.
raw docstring

wagoe.storage.shell.data-export

The storage module's contributions to data export and retention: a subject's uploads, listed and, in a zip export, included; and the upload retention policy.

The storage module's contributions to data export and retention: a
subject's uploads, listed and, in a zip export, included; and the upload
retention policy.
raw docstring

wagoe.storage.shell.export-job-http

Data export as a background job: POST /me/export-jobs for a signed-in user's own, or ExportJobs for another module's admin export; then GET /me/export-jobs/:id until it is done, then GET /me/export-jobs/:id/download. A job is visible only to who asked, and an export of someone else's data only while they are a platform admin.

Data export as a background job: POST /me/export-jobs for a signed-in
user's own, or `ExportJobs` for another module's admin export; then
GET /me/export-jobs/:id until it is done, then
GET /me/export-jobs/:id/download. A job is visible only to who asked, and
an export of someone else's data only while they are a platform admin.
raw docstring

wagoe.storage.shell.export-job-store

IExportJobStore on the application database.

`IExportJobStore` on the application database.
raw docstring

wagoe.storage.shell.export-jobs

Data export as a background job, for a subject too large to zip during a request: the job writes the archive to file storage, and its requester downloads it for a day. Needs the jobs module.

ctx here is {:store IExportJobStore :file-storage IFileStorage :provider kw :data-export IDataExport :job-queue IJobQueue :queue kw :requests-per-hour n}.

Data export as a background job, for a subject too large to zip during a
request: the job writes the archive to file storage, and its requester
downloads it for a day. Needs the jobs module.

`ctx` here is {:store IExportJobStore :file-storage IFileStorage
:provider kw :data-export IDataExport :job-queue IJobQueue :queue kw
:requests-per-hour n}.
raw docstring

wagoe.storage.shell.http-handlers

HTTP handlers for file upload and download operations.

Provides Ring-compatible handlers for file operations.

HTTP handlers for file upload and download operations.

Provides Ring-compatible handlers for file operations.
raw docstring

wagoe.storage.shell.module-wiring

Integrant lifecycle for the storage module.

Config key:

:wagoe/storage {:provider :local :root "uploads"} ; local filesystem {:provider :s3 :bucket "b" :region "eu-west-1"} ; AWS S3 / compatible {:provider :gcs :bucket "b" :project-id "p"} ; Google Cloud Storage

Returns {:provider <kw> :storage <IFileStorage> :service <IStorageService>}. Consumers (e.g. :wagoe/storage-routes) use :service.

The module also records every upload in storage_uploads (:wagoe.storage/upload-index), and contributes a subject's uploads to data export and the :storage/uploads retention policy. With the jobs module it also serves a user's export as a background job (export-jobs), offers other modules the same as :wagoe/export-jobs (privacy/IExportJobs), and contributes the :storage/export-archives retention policy.

The :local provider accepts the catalogue's :root as an alias for the local adapter's :base-path.

Integrant lifecycle for the storage module.

Config key:

:wagoe/storage
  {:provider :local :root "uploads"}                ; local filesystem
  {:provider :s3  :bucket "b" :region "eu-west-1"}  ; AWS S3 / compatible
  {:provider :gcs :bucket "b" :project-id "p"}      ; Google Cloud Storage

  Returns {:provider <kw> :storage <IFileStorage> :service <IStorageService>}.
  Consumers (e.g. :wagoe/storage-routes) use :service.

The module also records every upload in `storage_uploads`
(:wagoe.storage/upload-index), and contributes a subject's uploads to data
export and the `:storage/uploads` retention policy. With the jobs module it
also serves a user's export as a background job (`export-jobs`), offers
other modules the same as `:wagoe/export-jobs` (privacy/IExportJobs), and
contributes the `:storage/export-archives` retention policy.

The `:local` provider accepts the catalogue's `:root` as an alias for the
local adapter's `:base-path`.
raw docstring

wagoe.storage.shell.service

Storage service orchestrating file operations.

This service coordinates file validation, storage, and image processing. Follows the Functional Core / Imperative Shell pattern where this service represents the imperative shell that coordinates pure validation logic with side-effectful storage operations.

Storage service orchestrating file operations.

This service coordinates file validation, storage, and image processing.
Follows the Functional Core / Imperative Shell pattern where this service
represents the imperative shell that coordinates pure validation logic
with side-effectful storage operations.
raw docstring

wagoe.storage.shell.upload-index

IUploadIndex on the application database, and the boot step that creates its table.

`IUploadIndex` on the application database, and the boot step that creates
its table.
raw 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