Object Store

NOTICE: Experimental Preview

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.

Go

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

{% endtabs %}