BucketManager
in package
implements
BucketManagerInterface
Interfaces, Classes, Traits and Enums
Table of Contents
- $core : resource
- createBucket() : mixed
- Create a new bucket.
- dropBucket() : mixed
- Drop an existing bucket.
- flush() : mixed
- Flush an existing bucket.
- getAllBuckets() : array<string|int, mixed>
- Get all buckets.
- getBucket() : BucketSettings
- Get an existing bucket.
- removeBucket() : mixed
- Remove an existing bucket.
- updateBucket() : mixed
- Update an existing bucket.
Properties
$core
private
resource
$core
Methods
createBucket()
Create a new bucket.
public
createBucket(BucketSettings $settings[, CreateBucketOptions|null $options = null ]) : mixed
Parameters
- $settings : BucketSettings
-
the settings for the bucket.
- $options : CreateBucketOptions|null = null
-
the options to use when creating the bucket.
Tags
Return values
mixed —dropBucket()
Drop an existing bucket.
public
dropBucket(string $name[, DropBucketOptions|null $options = null ]) : mixed
Parameters
- $name : string
-
the name of the bucket.
- $options : DropBucketOptions|null = null
-
the options to use when dropping the bucket.
Tags
Return values
mixed —flush()
Flush an existing bucket.
public
flush(string $name[, FlushBucketOptions|null $options = null ]) : mixed
Parameters
- $name : string
-
the name of the bucket.
- $options : FlushBucketOptions|null = null
-
the options to use when flushing the bucket.
Tags
Return values
mixed —getAllBuckets()
Get all buckets.
public
getAllBuckets([GetAllQueryIndexesOptions|null $options = null ]) : array<string|int, mixed>
Parameters
- $options : GetAllQueryIndexesOptions|null = null
-
the options to use when getting the buckets.
Tags
Return values
array<string|int, mixed> —getBucket()
Get an existing bucket.
public
getBucket(string $name[, GetBucketOptions|null $options = null ]) : BucketSettings
Parameters
- $name : string
-
the name of the bucket.
- $options : GetBucketOptions|null = null
-
the options to use when getting the bucket.
Tags
Return values
BucketSettings —removeBucket()
Remove an existing bucket.
public
removeBucket(string $name) : mixed
Parameters
- $name : string
-
the name of the bucket.
Tags
Return values
mixed —updateBucket()
Update an existing bucket.
public
updateBucket(BucketSettings $settings[, UpdateBucketOptions|null $options = null ]) : mixed
Parameters
- $settings : BucketSettings
-
the settings for the bucket.
- $options : UpdateBucketOptions|null = null
-
the options to use when updating the bucket.