Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
soledad
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
leap
soledad
Commits
348711fa
Verified
Commit
348711fa
authored
7 years ago
by
drebs
Browse files
Options
Downloads
Patches
Plain Diff
[doc] improve documentation on IBlobsBackend
parent
94ddb9f8
Branches
Branches containing commit
No related tags found
1 merge request
!169
#9007 - improve and document IBlobsBackend
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/api/blobs-server-backend.rst
+20
-5
20 additions, 5 deletions
docs/api/blobs-server-backend.rst
with
20 additions
and
5 deletions
docs/api/blobs-server-backend.rst
+
20
−
5
View file @
348711fa
Blobs Server-side
Data
Backend
API
==================================
Blobs Server-side Backend
Interface
==================================
=
Blobs Backend Interface
-----------------------
The :ref:`blobs` functionality has the purpose of adding to Soledad the
capacity of handling binary objects efficiently. In this case, efficiency means
low use of resources (memory, cpu, and time) and storage scalability. The
choice of which data storage backend to use for Blobs affects each of these
properties in different ways.
The :ref:`blobs-backend-interface` is provided so that Soledad Server is
agnostic of which data backend is used for Blobs storage. In order to add a new
backend, one needs to:
* implement a backend according to the :ref:`IBlobsBackend <blobs-backend-interface>` interface,
* register the new handler in the Twisted-based ``BlobsResource``, and
* instantiate the Twisted-based ``BlobsResource`` using the new handler.
.. _blobs-backend-interface:
``IBlobsBackend`` Interface
---------------------------
.. autoclass:: leap.soledad.server.interfaces.IBlobsBackend
:members:
:undoc-members:
:special-members: __init__
:show-inheritance:
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment