Send feedback
Class Family (3.6.0) Stay organized with collections
Save and categorize content based on your preferences.
Version 3.6.0 keyboard_arrow_down
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
Properties
bigtable
Property Value
id
Property Value
metadata
?:
IColumnFamily
;
Property Value
name
Property Value
table
Property Value
Methods
create(options)
create
(
options
?:
CreateFamilyOptions
)
:
Promise<CreateFamilyResponse>
;
Parameter
Returns
create(options, callback)
create
(
options
:
CreateFamilyOptions
,
callback
:
CreateFamilyCallback
)
:
void
;
Parameters
Returns
create(callback)
create
(
callback
:
CreateFamilyCallback
)
:
void
;
Parameter
Returns
delete(gaxOptions)
delete
(
gaxOptions
?:
CallOptions
)
:
Promise<DeleteFamilyResponse>
;
Parameter
Returns
delete(gaxOptions, callback)
delete
(
gaxOptions
:
CallOptions
,
callback
:
DeleteFamilyCallback
)
:
void
;
Parameters
Returns
delete(callback)
delete
(
callback
:
DeleteFamilyCallback
)
:
void
;
Parameter
Returns
exists(gaxOptions)
exists
(
gaxOptions
?:
CallOptions
)
:
Promise<FamilyExistsResponse>
;
Parameter
Returns
exists(gaxOptions, callback)
exists
(
gaxOptions
:
CallOptions
,
callback
:
FamilyExistsCallback
)
:
void
;
Parameters
Returns
exists(callback)
exists
(
callback
:
FamilyExistsCallback
)
:
void
;
Parameter
Returns
static
formatRule_
(
ruleObj
:
GcRule
)
:
IGcRule
;
Formats Garbage Collection rule into proto format.
Parameter
Returns
get(options)
get
(
options
?:
GetFamilyOptions
)
:
Promise<GetFamilyResponse>
;
Parameter
Returns
get(options, callback)
get
(
options
:
GetFamilyOptions
,
callback
:
GetFamilyCallback
)
:
void
;
Parameters
Returns
get(callback)
get
(
callback
:
GetFamilyCallback
)
:
void
;
Parameter
Returns
getMetadata
(
gaxOptions
?:
CallOptions
)
:
Promise<GetFamilyMetadataResponse>
;
Parameter
Returns
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
setMetadata
(
metadata
:
SetFamilyMetadataOptions
,
gaxOptions
:
CallOptions
,
callback
:
SetFamilyMetadataCallback
)
:
void
;
Parameters
Returns
setMetadata
(
metadata
:
SetFamilyMetadataOptions
,
callback
:
SetFamilyMetadataCallback
)
:
void
;
Parameters
Returns
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
