BlobDelimiter Property

The delimiter to be used when listing blobs.

Syntax

 azureblob.getBlobDelimiter([callback])
 azureblob.setBlobDelimiter( blobDelimiter, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getBlobDelimiter([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setBlobDelimiter([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

If this property is set before calling ListBlobs, the delimiter parameter will be sent with the specified value. When a delimiter is specified, the returned blob list will contain BlobPrefix elements. These elements act as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character(s).

The PrefixList event will fire for each BlobPrefix element returned. Each BlobPrefix can then be used to traverse the virtual namespace hierarchy, by setting Prefix and calling ListBlobs.

Note, the Azure Blob Storage does not support hierarchical structures. However blob names can be used to simulate a virtual hierarchical folder structure.

For example, we have blobs with the following names:

MyCompany, MyCompany/Department1, MyCompany/Department2

If we set BlobDelimiter to "/", calling ListBlobs, will return the "MyCompany" blob. The PrefixList event will also fire for "MyCompany/".

If you then wanted to traverse the blobs contained within the "MyCompany/" virtual folder, you can set Prefix to "MyCompany/" and call ListBlobs. The resulting blob list will contain the "MyCompany/Department1" and "MyCompany/Department2" blobs.

This property is not available at design time.

Data Type

String