Console
    Contact Us Start free

    Class Table (3.6.0)

    Create a Table object to interact with a Cloud Bigtable table.

    Package

    @google-cloud/bigtable!

    Constructors

    (constructor)(instance, id)

      constructor 
 ( 
 instance 
 : 
  
 Instance 
 , 
  
 id 
 : 
  
 string 
 );

    Constructs a new instance of the Table class

    Parameters
    Name Description
    instance Instance
    id string

    Properties

    bigtable

      bigtable 
 : 
  
 Bigtable 
 ;
    Property Value
    Type Description
    Bigtable

    id

      id 
 : 
  
 string 
 ;
    Property Value
    Type Description
    string

    instance

      instance 
 : 
  
 Instance 
 ;
    Property Value
    Type Description
    Instance

    maxRetries

      maxRetries 
 ?: 
  
 number 
 ;
    Property Value
    Type Description
    number

    metadata

      metadata 
 ?: 
  
 google 
 . 
 bigtable 
 . 
 admin 
 . 
 v2 
 . 
 ITable 
 ;
    Property Value
    Type Description
    google.bigtable.admin.v2.ITable

    name

      name 
 : 
  
 string 
 ;
    Property Value
    Type Description
    string

    VIEWS

      static 
  
 VIEWS 
 : 
  
 { 
  
 [ 
 index 
 : 
  
 string 
 ] 
 : 
  
 number 
 ; 
  
 };

    The view to be applied to the returned table's fields. Defaults to schema if unspecified.

    Property Value
    Type Description
    { [index: string]: number; }

    Methods

    checkConsistency(token)

      checkConsistency 
 ( 
 token 
 : 
  
 string 
 ) 
 : 
  
 Promise<CheckConsistencyResponse> 
 ;
    Parameter
    Name Description
    token string
    Returns
    Type Description
    Promise < CheckConsistencyResponse >

    checkConsistency(token, callback)

      checkConsistency 
 ( 
 token 
 : 
  
 string 
 , 
  
 callback 
 : 
  
 CheckConsistencyCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    token string
    callback CheckConsistencyCallback
    Returns
    Type Description
    void

    create(options)

      create 
 ( 
 options 
 ?: 
  
 CreateTableOptions 
 ) 
 : 
  
 Promise<CreateTableResponse> 
 ;
    Parameter
    Name Description
    options CreateTableOptions
    Returns
    Type Description
    Promise < CreateTableResponse >

    create(options, callback)

      create 
 ( 
 options 
 : 
  
 CreateTableOptions 
 , 
  
 callback 
 : 
  
 CreateTableCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    options CreateTableOptions
    callback CreateTableCallback
    Returns
    Type Description
    void

    create(callback)

      create 
 ( 
 callback 
 : 
  
 CreateTableCallback 
 ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback CreateTableCallback
    Returns
    Type Description
    void

    createBackup(id, config)

      createBackup 
 ( 
 id 
 : 
  
 string 
 , 
  
 config 
 : 
  
 CreateBackupConfig 
 ) 
 : 
  
 Promise<CreateBackupResponse> 
 ;
    Parameters
    Name Description
    id string
    config CreateBackupConfig
    Returns
    Type Description
    Promise < CreateBackupResponse >

    createBackup(id, config, callback)

      createBackup 
 ( 
 id 
 : 
  
 string 
 , 
  
 config 
 : 
  
 CreateBackupConfig 
 , 
  
 callback 
 : 
  
 CreateBackupCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    id string
    config CreateBackupConfig
    callback CreateBackupCallback
    Returns
    Type Description
    void

    createBackup(id, config, callback)

      createBackup 
 ( 
 id 
 : 
  
 string 
 , 
  
 config 
 : 
  
 CreateBackupConfig 
 , 
  
 callback 
 : 
  
 CreateBackupCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    id string
    config CreateBackupConfig
    callback CreateBackupCallback
    Returns
    Type Description
    void

    createFamily(id, options)

      createFamily 
 ( 
 id 
 : 
  
 string 
 , 
  
 options 
 ?: 
  
 CreateFamilyOptions 
 ) 
 : 
  
 Promise<CreateFamilyResponse> 
 ;
    Parameters
    Name Description
    id string
    options CreateFamilyOptions
    Returns
    Type Description
    Promise < CreateFamilyResponse >

    createFamily(id, options, callback)

      createFamily 
 ( 
 id 
 : 
  
 string 
 , 
  
 options 
 : 
  
 CreateFamilyOptions 
 , 
  
 callback 
 : 
  
 CreateFamilyCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    id string
    options CreateFamilyOptions
    callback CreateFamilyCallback
    Returns
    Type Description
    void

    createFamily(id, callback)

      createFamily 
 ( 
 id 
 : 
  
 string 
 , 
  
 callback 
 : 
  
 CreateFamilyCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    id string
    callback CreateFamilyCallback
    Returns
    Type Description
    void

    createPrefixRange(start)

      static 
  
 createPrefixRange 
 ( 
 start 
 : 
  
 string 
 ) 
 : 
  
 PrefixRange 
 ;

    Creates a range based off of a key prefix.

    Parameter
    Name Description
    start string

    The key prefix/starting bound.
    Returns
    Type Description
    PrefixRange

    {object} range

    createReadStream(opts)

      createReadStream 
 ( 
 opts 
 ?: 
  
 GetRowsOptions 
 ) 
 : 
  
 PassThrough 
 ;

    Get Row objects for the rows currently in your table as a readable object stream.

    Parameter
    Name Description
    opts GetRowsOptions
    Returns
    Type Description
    PassThrough

    {stream}

    decodePolicyEtag(policy)

      static 
  
 decodePolicyEtag 
 ( 
 policy 
 : 
  
 Policy 
 ) 
 : 
  
 Policy 
 ;

    Formats the decodes policy etag value to string.

    Parameter
    Name Description
    policy Policy
    Returns
    Type Description
    Policy

    delete(gaxOptions)

      delete 
 ( 
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<DeleteTableResponse> 
 ;
    Parameter
    Name Description
    gaxOptions CallOptions
    Returns
    Type Description
    Promise < DeleteTableResponse >

    delete(gaxOptions, callback)

      delete 
 ( 
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 DeleteTableCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    gaxOptions CallOptions
    callback DeleteTableCallback
    Returns
    Type Description
    void

    delete(callback)

      delete 
 ( 
 callback 
 : 
  
 DeleteTableCallback 
 ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback DeleteTableCallback
    Returns
    Type Description
    void

    deleteRows(prefix, gaxOptions)

      deleteRows 
 ( 
 prefix 
 : 
  
 string 
 , 
  
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<DeleteRowsResponse> 
 ;
    Parameters
    Name Description
    prefix string
    gaxOptions CallOptions
    Returns
    Type Description
    Promise < DeleteRowsResponse >

    deleteRows(prefix, gaxOptions, callback)

      deleteRows 
 ( 
 prefix 
 : 
  
 string 
 , 
  
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 DeleteRowsCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    prefix string
    gaxOptions CallOptions
    callback DeleteRowsCallback
    Returns
    Type Description
    void

    deleteRows(prefix, callback)

      deleteRows 
 ( 
 prefix 
 : 
  
 string 
 , 
  
 callback 
 : 
  
 DeleteRowsCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    prefix string
    callback DeleteRowsCallback
    Returns
    Type Description
    void

    exists(gaxOptions)

      exists 
 ( 
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<TableExistsResponse> 
 ;
    Parameter
    Name Description
    gaxOptions CallOptions
    Returns
    Type Description
    Promise < TableExistsResponse >

    exists(gaxOptions, callback)

      exists 
 ( 
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 TableExistsCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    gaxOptions CallOptions
    callback TableExistsCallback
    Returns
    Type Description
    void

    exists(callback)

      exists 
 ( 
 callback 
 : 
  
 TableExistsCallback 
 ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback TableExistsCallback
    Returns
    Type Description
    void

    family(id)

      family 
 ( 
 id 
 : 
  
 string 
 ) 
 : 
  
 Family 
 ;

    Get a reference to a Table Family.

    Parameter
    Name Description
    id string

    The family unique identifier.
    Returns
    Type Description
    Family

    {Family}

    formatName_(instanceName, id)

      static 
  
 formatName_ 
 ( 
 instanceName 
 : 
  
 string 
 , 
  
 id 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Formats the table name to include the Bigtable cluster.

    Parameters
    Name Description
    instanceName string

    The formatted instance name.
    id string
    Returns
    Type Description
    string

    generateConsistencyToken()

      generateConsistencyToken 
 () 
 : 
  
 Promise<GenerateConsistencyTokenResponse> 
 ;
    Returns
    Type Description
    Promise < GenerateConsistencyTokenResponse >

    generateConsistencyToken(callback)

      generateConsistencyToken 
 ( 
 callback 
 : 
  
 GenerateConsistencyTokenCallback 
 ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback GenerateConsistencyTokenCallback
    Returns
    Type Description
    void

    get(options)

      get 
 ( 
 options 
 ?: 
  
 GetTableOptions 
 ) 
 : 
  
 Promise<GetTableResponse> 
 ;
    Parameter
    Name Description
    options GetTableOptions
    Returns
    Type Description
    Promise < GetTableResponse >

    get(options, callback)

      get 
 ( 
 options 
 : 
  
 GetTableOptions 
 , 
  
 callback 
 : 
  
 GetTableCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    options GetTableOptions
    callback GetTableCallback
    Returns
    Type Description
    void

    get(callback)

      get 
 ( 
 callback 
 : 
  
 GetTableCallback 
 ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback GetTableCallback
    Returns
    Type Description
    void

    getFamilies(gaxOptions)

      getFamilies 
 ( 
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<GetFamiliesResponse> 
 ;
    Parameter
    Name Description
    gaxOptions CallOptions
    Returns
    Type Description
    Promise < GetFamiliesResponse >

    getFamilies(gaxOptions, callback)

      getFamilies 
 ( 
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 GetFamiliesCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    gaxOptions CallOptions
    callback GetFamiliesCallback
    Returns
    Type Description
    void

    getFamilies(callback)

      getFamilies 
 ( 
 callback 
 : 
  
 GetFamiliesCallback 
 ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback GetFamiliesCallback
    Returns
    Type Description
    void

    getIamPolicy(options)

      getIamPolicy 
 ( 
 options 
 ?: 
  
 GetIamPolicyOptions 
 ) 
 : 
  
 Promise 
< [ 
 Policy 
 ]>;
    Parameter
    Name Description
    options GetIamPolicyOptions
    Returns
    Type Description
    Promise <[ Policy ]>

    getIamPolicy(options, callback)

      getIamPolicy 
 ( 
 options 
 : 
  
 GetIamPolicyOptions 
 , 
  
 callback 
 : 
  
 GetIamPolicyCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    options GetIamPolicyOptions
    callback GetIamPolicyCallback
    Returns
    Type Description
    void

    getMetadata(options)

      getMetadata 
 ( 
 options 
 ?: 
  
 GetMetadataOptions 
 ) 
 : 
  
 Promise<GetMetadataResponse> 
 ;
    Parameter
    Name Description
    options GetMetadataOptions
    Returns
    Type Description
    Promise < GetMetadataResponse >

    getMetadata(options, callback)

      getMetadata 
 ( 
 options 
 : 
  
 GetMetadataOptions 
 , 
  
 callback 
 : 
  
 GetMetadataCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    options GetMetadataOptions
    callback GetMetadataCallback
    Returns
    Type Description
    void

    getMetadata(callback)

      getMetadata 
 ( 
 callback 
 : 
  
 GetMetadataCallback 
 ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback GetMetadataCallback
    Returns
    Type Description
    void

    getReplicationStates(gaxOptions)

      getReplicationStates 
 ( 
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<GetReplicationStatesResponse> 
 ;
    Parameter
    Name Description
    gaxOptions CallOptions
    Returns
    Type Description
    Promise < GetReplicationStatesResponse >

    getReplicationStates(gaxOptions, callback)

      getReplicationStates 
 ( 
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 GetReplicationStatesCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    gaxOptions CallOptions
    callback GetReplicationStatesCallback
    Returns
    Type Description
    void

    getReplicationStates(callback)

      getReplicationStates 
 ( 
 callback 
 : 
  
 GetReplicationStatesCallback 
 ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback GetReplicationStatesCallback
    Returns
    Type Description
    void

    getRows(options)

      getRows 
 ( 
 options 
 ?: 
  
 GetRowsOptions 
 ) 
 : 
  
 Promise<GetRowsResponse> 
 ;
    Parameter
    Name Description
    options GetRowsOptions
    Returns
    Type Description
    Promise < GetRowsResponse >

    getRows(options, callback)

      getRows 
 ( 
 options 
 : 
  
 GetRowsOptions 
 , 
  
 callback 
 : 
  
 GetRowsCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    options GetRowsOptions
    callback GetRowsCallback
    Returns
    Type Description
    void

    getRows(callback)

      getRows 
 ( 
 callback 
 : 
  
 GetRowsCallback 
 ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback GetRowsCallback
    Returns
    Type Description
    void

    insert(entries, gaxOptions)

      insert 
 ( 
 entries 
 : 
  
 Entry 
  
 | 
  
 Entry 
 [], 
  
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<InsertRowsResponse> 
 ;
    Parameters
    Name Description
    entries Entry | Entry []
    gaxOptions CallOptions
    Returns
    Type Description
    Promise < InsertRowsResponse >

    insert(entries, gaxOptions, callback)

      insert 
 ( 
 entries 
 : 
  
 Entry 
  
 | 
  
 Entry 
 [], 
  
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 InsertRowsCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    entries Entry | Entry []
    gaxOptions CallOptions
    callback InsertRowsCallback
    Returns
    Type Description
    void

    insert(entries, callback)

      insert 
 ( 
 entries 
 : 
  
 Entry 
  
 | 
  
 Entry 
 [], 
  
 callback 
 : 
  
 InsertRowsCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    entries Entry | Entry []
    callback InsertRowsCallback
    Returns
    Type Description
    void

    mutate(entries, options)

      mutate 
 ( 
 entries 
 : 
  
 Entry 
  
 | 
  
 Entry 
 [], 
  
 options 
 ?: 
  
 MutateOptions 
 ) 
 : 
  
 Promise<MutateResponse> 
 ;
    Parameters
    Name Description
    entries Entry | Entry []
    options MutateOptions
    Returns
    Type Description
    Promise < MutateResponse >

    mutate(entries, options, callback)

      mutate 
 ( 
 entries 
 : 
  
 Entry 
  
 | 
  
 Entry 
 [], 
  
 options 
 : 
  
 MutateOptions 
 , 
  
 callback 
 : 
  
 MutateCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    entries Entry | Entry []
    options MutateOptions
    callback MutateCallback
    Returns
    Type Description
    void

    mutate(entries, callback)

      mutate 
 ( 
 entries 
 : 
  
 Entry 
  
 | 
  
 Entry 
 [], 
  
 callback 
 : 
  
 MutateCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    entries Entry | Entry []
    callback MutateCallback
    Returns
    Type Description
    void

    row(key)

      row 
 ( 
 key 
 : 
  
 string 
 ) 
 : 
  
 Row 
 ;

    Get a reference to a table row.

    Parameter
    Name Description
    key string

    The row key.
    Returns
    Type Description
    Row

    {Row}

    sampleRowKeys(gaxOptions)

      sampleRowKeys 
 ( 
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<SampleRowsKeysResponse> 
 ;
    Parameter
    Name Description
    gaxOptions CallOptions
    Returns
    Type Description
    Promise < SampleRowsKeysResponse >

    sampleRowKeys(gaxOptions, callback)

      sampleRowKeys 
 ( 
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 SampleRowKeysCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    gaxOptions CallOptions
    callback SampleRowKeysCallback
    Returns
    Type Description
    void

    sampleRowKeys(callback)

      sampleRowKeys 
 ( 
 callback 
 ?: 
  
 SampleRowKeysCallback 
 ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback SampleRowKeysCallback
    Returns
    Type Description
    void

    sampleRowKeysStream(gaxOptions)

      sampleRowKeysStream 
 ( 
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 any 
 ;

    Returns a sample of row keys in the table as a readable object stream.

    See for more details.

    Parameter
    Name Description
    gaxOptions CallOptions

    Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html .
    Returns
    Type Description
    any

    {stream}

    setIamPolicy(policy, gaxOptions)

      setIamPolicy 
 ( 
 policy 
 : 
  
 Policy 
 , 
  
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<SetIamPolicyResponse> 
 ;
    Parameters
    Name Description
    policy Policy
    gaxOptions CallOptions
    Returns
    Type Description
    Promise < SetIamPolicyResponse >

    setIamPolicy(policy, callback)

      setIamPolicy 
 ( 
 policy 
 : 
  
 Policy 
 , 
  
 callback 
 : 
  
 SetIamPolicyCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    policy Policy
    callback SetIamPolicyCallback
    Returns
    Type Description
    void

    setIamPolicy(policy, gaxOptions, callback)

      setIamPolicy 
 ( 
 policy 
 : 
  
 Policy 
 , 
  
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 SetIamPolicyCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    policy Policy
    gaxOptions CallOptions
    callback SetIamPolicyCallback
    Returns
    Type Description
    void

    testIamPermissions(permissions, gaxOptions)

      testIamPermissions 
 ( 
 permissions 
 : 
  
 string 
  
 | 
  
 string 
 [], 
  
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<TestIamPermissionsResponse> 
 ;
    Parameters
    Name Description
    permissions string | string[]
    gaxOptions CallOptions
    Returns
    Type Description
    Promise < TestIamPermissionsResponse >

    testIamPermissions(permissions, callback)

      testIamPermissions 
 ( 
 permissions 
 : 
  
 string 
  
 | 
  
 string 
 [], 
  
 callback 
 : 
  
 TestIamPermissionsCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    permissions string | string[]
    callback TestIamPermissionsCallback
    Returns
    Type Description
    void

    testIamPermissions(permissions, gaxOptions, callback)

      testIamPermissions 
 ( 
 permissions 
 : 
  
 string 
  
 | 
  
 string 
 [], 
  
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 TestIamPermissionsCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    permissions string | string[]
    gaxOptions CallOptions
    callback TestIamPermissionsCallback
    Returns
    Type Description
    void

    truncate(gaxOptions)

      truncate 
 ( 
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<TruncateResponse> 
 ;
    Parameter
    Name Description
    gaxOptions CallOptions
    Returns
    Type Description
    Promise < TruncateResponse >

    truncate(gaxOptions, callback)

      truncate 
 ( 
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 TruncateCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    gaxOptions CallOptions
    callback TruncateCallback
    Returns
    Type Description
    void

    truncate(callback)

      truncate 
 ( 
 callback 
 : 
  
 TruncateCallback 
 ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback TruncateCallback
    Returns
    Type Description
    void

    waitForReplication()

      waitForReplication 
 () 
 : 
  
 Promise<WaitForReplicationResponse> 
 ;
    Returns
    Type Description
    Promise < WaitForReplicationResponse >

    waitForReplication(callback)

      waitForReplication 
 ( 
 callback 
 : 
  
 WaitForReplicationCallback 
 ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback WaitForReplicationCallback
    Returns
    Type Description
    void
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: