Package com.github.ambry.named

Interface NamedBlobDb

public interface NamedBlobDb

A layer for interacting with a metadata store that holds mappings between blob names and blob IDs.

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<DeleteResult>	delete(java.lang.String accountName, java.lang.String containerName, java.lang.String blobName)	Delete a record for a blob in the database.
java.util.concurrent.CompletableFuture<NamedBlobRecord>	get(java.lang.String accountName, java.lang.String containerName, java.lang.String blobName)	Look up a NamedBlobRecord by name.
java.util.concurrent.CompletableFuture<Page<NamedBlobRecord>>	list(java.lang.String accountName, java.lang.String containerName, java.lang.String blobNamePrefix, java.lang.String continuationToken)	List blobs that start with a provided prefix in a container.
java.util.concurrent.CompletableFuture<PutResult>	put(NamedBlobRecord record)	Persist a NamedBlobRecord in the database.

Method Detail

get

java.util.concurrent.CompletableFuture<NamedBlobRecord> get(java.lang.String accountName,
                                                            java.lang.String containerName,
                                                            java.lang.String blobName)

Look up a NamedBlobRecord by name.

Parameters:

accountName - the name of the account.

containerName - the name of the container.

blobName - the name of the blob.

Returns:

a CompletableFuture that will eventually contain either the NamedBlobRecord for the named blob or an exception if an error occurred.

list

java.util.concurrent.CompletableFuture<Page<NamedBlobRecord>> list(java.lang.String accountName,
                                                                   java.lang.String containerName,
                                                                   java.lang.String blobNamePrefix,
                                                                   java.lang.String continuationToken)

List blobs that start with a provided prefix in a container. This returns paginated results. If there are additional pages to read, Page.getContinuationToken() will be non null.

Parameters:

accountName - the name of the account.

containerName - the name of the container.

blobNamePrefix - the name prefix to search for.

continuationToken - if null, return the first page of NamedBlobRecords that start with blobNamePrefix. If set, use this as a token to resume reading additional pages of records that start with the prefix.

Returns:

a CompletableFuture that will eventually contain a Page of NamedBlobRecords starting with the specified prefix or an exception if an error occurred.

put

java.util.concurrent.CompletableFuture<PutResult> put(NamedBlobRecord record)

Persist a NamedBlobRecord in the database.

Parameters:

record - the NamedBlobRecord

Returns:

a CompletableFuture that will eventually contain a PutResult or an exception if an error occurred.

delete

java.util.concurrent.CompletableFuture<DeleteResult> delete(java.lang.String accountName,
                                                            java.lang.String containerName,
                                                            java.lang.String blobName)

Delete a record for a blob in the database.

Parameters:

accountName - the name of the account.

containerName - the name of the container.

blobName - the name of the blob.

Returns:

a CompletableFuture that will eventually contain a DeleteResult or an exception if an error occurred.