AzureStore

blobstore.azure.AzureStore
See theAzureStore companion object
class AzureStore[F[_]](azure: BlobServiceAsyncClient, defaultFullMetadata: Boolean, defaultTrailingSlashFiles: Boolean, blockSize: Int, numBuffers: Int, queueSize: Int)(using evidence$1: ConcurrentEffect[F]) extends Store[F, AzureBlob]

Value parameters

azure

Azure Blob Service Async Client

blockSize

for upload, The block size is the size of each block that will be staged. This value also determines the number of requests that need to be made. If block size is large, upload will make fewer network calls, but each individual call will send more data and will therefore take longer. This parameter also determines the size that each buffer uses when buffering is required and consequently amount of memory consumed by such methods may be up to blockSize

  • numBuffers.
defaultFullMetadata

return full object metadata on list, requires additional request per object. Metadata returned by default: size, lastModified, eTag, storageClass. This controls behaviour of list method from Store trait. Use listUnderlying to control on per-invocation basis.

defaultTrailingSlashFiles

test if folders returned by list are files with trailing slashes in their names. This controls behaviour of list method from Store trait. Use listUnderlying to control on per-invocation basis.

numBuffers

for buffered upload only, the number of buffers is the maximum number of buffers this method should allocate. Memory will be allocated lazily as needed. Must be at least two. Typically, the larger the number of buffers, the more parallel, and thus faster, the upload portion of this operation will be. The amount of memory consumed by methods using this value may be up to blockSize * numBuffers.

Attributes

Companion
object
Graph
Supertypes
trait Store[F, AzureBlob]
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def copy[A, B](src: Url[A], dst: Url[B]): F[Unit]

Copies bytes from srcPath to dstPath. Stores should optimize to use native copy functions to avoid data transfer.

Copies bytes from srcPath to dstPath. Stores should optimize to use native copy functions to avoid data transfer.

Value parameters

dst

path

src

path

Attributes

Returns

F[Unit]

Definition Classes
Store
override def get[A](url: Url[A], chunkSize: Int): Stream[F, Byte]

Value parameters

chunkSize

bytes to read in each chunk.

url

to get

Attributes

Returns

stream of bytes

Definition Classes
Store
override def list[A](url: Url[A], recursive: Boolean): Stream[F, Url[AzureBlob]]

Value parameters

recursive

when true returned list would contain files at given path and all sub-folders but no folders, otherwise – return files and folder at given path.

url

to list

Attributes

Returns

stream of Paths. Implementing stores must guarantee that returned Paths have correct values for size, isDir and lastModified.

Example

Given Path pointing at folder: folder/a folder/b folder/c folder/sub-folder/d folder/sub-folder/sub-sub-folder/e list(folder, recursive = true) -> [a, b, c, d, e] list(folder, recursive = false) -> [a, b, c, sub-folder]

Definition Classes
Store
def listUnderlying[A](url: Url[A], fullMetadata: Boolean, expectTrailingSlashFiles: Boolean, recursive: Boolean): Stream[F, Url[AzureBlob]]
override def move[A, B](src: Url[A], dst: Url[B]): F[Unit]

Moves bytes from srcPath to dstPath. Stores should optimize to use native move functions to avoid data transfer.

Moves bytes from srcPath to dstPath. Stores should optimize to use native move functions to avoid data transfer.

Value parameters

dst

path

src

path

Attributes

Returns

F[Unit]

Definition Classes
Store
override def put[A](url: Url[A], overwrite: Boolean, size: Option[Long]): (F, Byte) => Unit

Value parameters

overwrite

when true putting to path with pre-existing file would overwrite the content, otherwise – fail with error.

url

to put

Attributes

Returns

sink of bytes

Definition Classes
Store
def put[A](url: Url[A], overwrite: Boolean, properties: Option[BlobItemProperties], meta: Map[String, String]): (F, Byte) => Unit
override def putRotate[A](computeUrl: F[Url[A]], limit: Long): (F, Byte) => Unit

Writes all data to a sequence of blobs/files, each limited in size to limit.

Writes all data to a sequence of blobs/files, each limited in size to limit.

The computeUrl operation is used to compute the path of the first file and every subsequent file. Typically, the next file should be determined by analyzing the current state of the filesystem -- e.g., by looking at all files in a directory and generating a unique name.

Value parameters

computeUrl

operation to compute the url of the first file and all subsequent files.

limit

maximum size in bytes for each file.

Attributes

Returns

sink of bytes

Note

Put of all files uses overwrite semantic, i.e. if path returned by computeUrl already exists content will be overwritten. If that doesn't suit your use case use computeUrl to guard against overwriting existing files.

Definition Classes
Store
override def remove[A](url: Url[A], recursive: Boolean): F[Unit]

Remove bytes for given path. Call should succeed even if there is nothing stored at that path.

Remove bytes for given path. Call should succeed even if there is nothing stored at that path.

Value parameters

url

to remove

Attributes

Returns

F[Unit]

Definition Classes
Store
override def stat[A](url: Url[A]): Stream[F, Url[AzureBlob]]

Attributes

Definition Classes
Store