Object Store

The Object Store allows you to store data of any (i.e. large) size by implementing a chunking mechanism, allowing you to for example store and retrieve files (i.e. the object) of any size by associating them with a path and a file name (i.e. the key). You obtain a ObjectStoreManager object from your JetStream context.

{% tabs %} {% tab title=”Go” %}

  1. // ObjectStoreManager creates, loads and deletes Object Stores
  2. //
  3. // This functionality is EXPERIMENTAL and may be changed in later releases.
  4. type ObjectStoreManager interface {
  5.     // ObjectStore will lookup and bind to an existing object store instance.
  6.     ObjectStore(bucket string) (ObjectStore, error)
  7.     // CreateObjectStore will create an object store.
  8.     CreateObjectStore(cfg *ObjectStoreConfig) (ObjectStore, error)
  9.     // DeleteObjectStore will delete the underlying stream for the named object.
  10.     DeleteObjectStore(bucket string) error
  11. }
  13. // ObjectStore is a blob store capable of storing large objects efficiently in
  14. // JetStream streams
  15. //
  16. // This functionality is EXPERIMENTAL and may be changed in later releases.
  17. type ObjectStore interface {
  18.     // Put will place the contents from the reader into a new object.
  19.     Put(obj *ObjectMeta, reader io.Reader, opts ...ObjectOpt) (*ObjectInfo, error)
  20.     // Get will pull the named object from the object store.
  21.     Get(name string, opts ...ObjectOpt) (ObjectResult, error)
  23.     // PutBytes is convenience function to put a byte slice into this object store.
  24.     PutBytes(name string, data []byte, opts ...ObjectOpt) (*ObjectInfo, error)
  25.     // GetBytes is a convenience function to pull an object from this object store and return it as a byte slice.
  26.     GetBytes(name string, opts ...ObjectOpt) ([]byte, error)
  28.     // PutBytes is convenience function to put a string into this object store.
  29.     PutString(name string, data string, opts ...ObjectOpt) (*ObjectInfo, error)
  30.     // GetString is a convenience function to pull an object from this object store and return it as a string.
  31.     GetString(name string, opts ...ObjectOpt) (string, error)
  33.     // PutFile is convenience function to put a file into this object store.
  34.     PutFile(file string, opts ...ObjectOpt) (*ObjectInfo, error)
  35.     // GetFile is a convenience function to pull an object from this object store and place it in a file.
  36.     GetFile(name, file string, opts ...ObjectOpt) error
  38.     // GetInfo will retrieve the current information for the object.
  39.     GetInfo(name string) (*ObjectInfo, error)
  40.     // UpdateMeta will update the meta data for the object.
  41.     UpdateMeta(name string, meta *ObjectMeta) error
  43.     // Delete will delete the named object.
  44.     Delete(name string) error
  46.     // AddLink will add a link to another object into this object store.
  47.     AddLink(name string, obj *ObjectInfo) (*ObjectInfo, error)
  49.     // AddBucketLink will add a link to another object store.
  50.     AddBucketLink(name string, bucket ObjectStore) (*ObjectInfo, error)
  52.     // Seal will seal the object store, no further modifications will be allowed.
  53.     Seal() error
  55.     // Watch for changes in the underlying store and receive meta information updates.
  56.     Watch(opts ...WatchOpt) (ObjectWatcher, error)
  58.     // List will list all the objects in this store.
  59.     List(opts ...WatchOpt) ([]*ObjectInfo, error)
  61.     // Status retrieves run-time status about the backing store of the bucket.
  62.     Status() (ObjectStoreStatus, error)
  63. }

{% endtab %} {% endtabs %}