Create a Family object to interact with your table column families.
Package
@google-cloud/bigtable!
Constructors
(constructor)(table, id)
constructor(table: Table, id: string);
Constructs a new instance of the Family
class
Parameters
Name | Description |
table |
Table
|
id |
string
|
Properties
bigtable
Property Value
id
Property Value
metadata?: IColumnFamily;
Property Value
Type | Description |
IColumnFamily | |
name
Property Value
table
Property Value
Methods
create(options)
create(options?: CreateFamilyOptions): Promise<CreateFamilyResponse>;
Parameter
Returns
Type | Description |
Promise<CreateFamilyResponse> | |
create(options, callback)
create(options: CreateFamilyOptions, callback: CreateFamilyCallback): void;
Parameters
Returns
create(callback)
create(callback: CreateFamilyCallback): void;
Parameter
Name | Description |
callback |
CreateFamilyCallback
|
Returns
delete(gaxOptions)
delete(gaxOptions?: CallOptions): Promise<DeleteFamilyResponse>;
Parameter
Name | Description |
gaxOptions |
CallOptions
|
Returns
Type | Description |
Promise<DeleteFamilyResponse> | |
delete(gaxOptions, callback)
delete(gaxOptions: CallOptions, callback: DeleteFamilyCallback): void;
Parameters
Name | Description |
gaxOptions |
CallOptions
|
callback |
DeleteFamilyCallback
|
Returns
delete(callback)
delete(callback: DeleteFamilyCallback): void;
Parameter
Name | Description |
callback |
DeleteFamilyCallback
|
Returns
exists(gaxOptions)
exists(gaxOptions?: CallOptions): Promise<FamilyExistsResponse>;
Parameter
Name | Description |
gaxOptions |
CallOptions
|
Returns
Type | Description |
Promise<FamilyExistsResponse> | |
exists(gaxOptions, callback)
exists(gaxOptions: CallOptions, callback: FamilyExistsCallback): void;
Parameters
Name | Description |
gaxOptions |
CallOptions
|
callback |
FamilyExistsCallback
|
Returns
exists(callback)
exists(callback: FamilyExistsCallback): void;
Parameter
Name | Description |
callback |
FamilyExistsCallback
|
Returns
static formatRule_(ruleObj: GcRule): IGcRule;
Formats Garbage Collection rule into proto format.
Parameter
Name | Description |
ruleObj |
GcRule
The rule object.
|
Returns
Type | Description |
IGcRule | {object}
|
get(options)
get(options?: GetFamilyOptions): Promise<GetFamilyResponse>;
Parameter
Returns
Type | Description |
Promise<GetFamilyResponse> | |
get(options, callback)
get(options: GetFamilyOptions, callback: GetFamilyCallback): void;
Parameters
Returns
get(callback)
get(callback: GetFamilyCallback): void;
Parameter
Name | Description |
callback |
GetFamilyCallback
|
Returns
getMetadata(gaxOptions?: CallOptions): Promise<GetFamilyMetadataResponse>;
Parameter
Name | Description |
gaxOptions |
CallOptions
|
Returns
Type | Description |
Promise<GetFamilyMetadataResponse> | |
getMetadata(gaxOptions: CallOptions, callback: GetFamilyMetadataCallback): void;
Parameters
Name | Description |
gaxOptions |
CallOptions
|
callback |
GetFamilyMetadataCallback
|
Returns
getMetadata(callback: GetFamilyMetadataCallback): void;
Parameter
Name | Description |
callback |
GetFamilyMetadataCallback
|
Returns
setMetadata(metadata: SetFamilyMetadataOptions, gaxOptions?: CallOptions): Promise<SetFamilyMetadataResponse>;
Parameters
Returns
Type | Description |
Promise<SetFamilyMetadataResponse> | |
setMetadata(metadata: SetFamilyMetadataOptions, gaxOptions: CallOptions, callback: SetFamilyMetadataCallback): void;
Parameters
Returns
setMetadata(metadata: SetFamilyMetadataOptions, callback: SetFamilyMetadataCallback): void;
Parameters
Returns