Notice

This document is for a development version of Ceph.

Report a Documentation Bug

Ceph Storage Cluster APIs

The Ceph Storage Cluster has a messaging layer protocol that enables clients to interact with a Ceph Monitor and a Ceph OSD Daemon. librados provides this functionality to Ceph Clients in the form of a library. All Ceph Clients either use librados or the same functionality encapsulated in librados to interact with the object store. For example, librbd and libcephfs leverage this functionality. You may use librados to interact with Ceph directly (e.g., an application that talks to Ceph, your own interface to Ceph, etc.).

• Introduction to librados
  • Step 1: Getting librados
  • Step 2: Configuring a Cluster Handle
  • Step 3: Creating an I/O Context
  • Step 4: Closing Sessions
• librados (C)
  • Example: connecting and writing an object
  • Asynchronous IO
  • API calls
• librados (C++)
• librados (Python)
  • Installation
  • Getting Started
  • Cluster Handle API
  • Input/Output Context API
  • Object Interface
• libcephsqlite (SQLite)
  • Usage
  • User
  • Page Size
  • Cache
  • Journal Persistence
  • Exclusive Lock Mode
  • WAL Journal
  • Performance Notes
  • Recommended Use-Cases
  • Parallel Access
  • Export or Extract Database out of RADOS
  • Temporary Tables
  • Breaking Locks
  • How to Corrupt Your Database
  • Performance Statistics
  • Debugging
• object class
  • Installing objclass.h
  • Using the SDK example

Brought to you by the Ceph Foundation

The Ceph Documentation is a community resource funded and hosted by the non-profit Ceph Foundation. If you would like to support this and our other efforts, please consider joining now.