Console
    Contact Us Start free

    Class Table (5.6.0)

    Table objects are returned by methods such as , , and .

    Inheritance

    common. ServiceObject > Table

    Package

    @google-cloud/bigquery!

    Constructors

    (constructor)(dataset, id, options)

      constructor 
 ( 
 dataset 
 : 
  
 Dataset 
 , 
  
 id 
 : 
  
 string 
 , 
  
 options 
 ?: 
  
 TableOptions 
 );

    Constructs a new instance of the Table class

    Parameters
    Name Description
    dataset Dataset
    id string
    options TableOptions

    Properties

    bigQuery

      bigQuery 
 : 
  
 BigQuery 
 ;
    Property Value
    Type Description
    BigQuery

    createReadStream

      createReadStream 
 : 
  
 ( 
 options 
 ?: 
  
 GetRowsOptions 
 ) 
  
 = 
>  
 ResourceStream<RowMetadata> 
 ;
    Property Value
    Type Description
    (options?: GetRowsOptions ) => ResourceStream < RowMetadata >

    dataset

      dataset 
 : 
  
 Dataset 
 ;
    Property Value
    Type Description
    Dataset

    location

      location 
 ?: 
  
 string 
 ;
    Property Value
    Type Description
    string

    Methods

    _createLoadJob(source, metadata)

      _createLoadJob 
 ( 
 source 
 : 
  
 string 
  
 | 
  
 File 
  
 | 
  
 File 
 [], 
  
 metadata 
 : 
  
 JobLoadMetadata 
 ) 
 : 
  
 Promise<JobResponse> 
 ;
    Parameters
    Name Description
    source string | File | File []
    metadata JobLoadMetadata
    Returns
    Type Description
    Promise < JobResponse >

    {Promise

    copy(destination, metadata)

      copy 
 ( 
 destination 
 : 
  
 Table 
 , 
  
 metadata 
 ?: 
  
 CopyTableMetadata 
 ) 
 : 
  
 Promise<JobMetadataResponse> 
 ;
    Parameters
    Name Description
    destination Table
    metadata CopyTableMetadata
    Returns
    Type Description
    Promise < JobMetadataResponse >

    copy(destination, metadata, callback)

      copy 
 ( 
 destination 
 : 
  
 Table 
 , 
  
 metadata 
 : 
  
 CopyTableMetadata 
 , 
  
 callback 
 : 
  
 JobMetadataCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    destination Table
    metadata CopyTableMetadata
    callback JobMetadataCallback
    Returns
    Type Description
    void

    copy(destination, callback)

      copy 
 ( 
 destination 
 : 
  
 Table 
 , 
  
 callback 
 : 
  
 JobMetadataCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    destination Table
    callback JobMetadataCallback
    Returns
    Type Description
    void

    copyFrom(sourceTables, metadata)

      copyFrom 
 ( 
 sourceTables 
 : 
  
 Table 
  
 | 
  
 Table 
 [], 
  
 metadata 
 ?: 
  
 CopyTableMetadata 
 ) 
 : 
  
 Promise<JobMetadataResponse> 
 ;
    Parameters
    Name Description
    sourceTables Table | Table []
    metadata CopyTableMetadata
    Returns
    Type Description
    Promise < JobMetadataResponse >

    copyFrom(sourceTables, metadata, callback)

      copyFrom 
 ( 
 sourceTables 
 : 
  
 Table 
  
 | 
  
 Table 
 [], 
  
 metadata 
 : 
  
 CopyTableMetadata 
 , 
  
 callback 
 : 
  
 JobMetadataCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    sourceTables Table | Table []
    metadata CopyTableMetadata
    callback JobMetadataCallback
    Returns
    Type Description
    void

    copyFrom(sourceTables, callback)

      copyFrom 
 ( 
 sourceTables 
 : 
  
 Table 
  
 | 
  
 Table 
 [], 
  
 callback 
 : 
  
 JobMetadataCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    sourceTables Table | Table []
    callback JobMetadataCallback
    Returns
    Type Description
    void

    createCopyFromJob(source, metadata)

      createCopyFromJob 
 ( 
 source 
 : 
  
 Table 
  
 | 
  
 Table 
 [], 
  
 metadata 
 ?: 
  
 CopyTableMetadata 
 ) 
 : 
  
 Promise<JobResponse> 
 ;
    Parameters
    Name Description
    source Table | Table []
    metadata CopyTableMetadata
    Returns
    Type Description
    Promise < JobResponse >

    createCopyFromJob(source, metadata, callback)

      createCopyFromJob 
 ( 
 source 
 : 
  
 Table 
  
 | 
  
 Table 
 [], 
  
 metadata 
 : 
  
 CopyTableMetadata 
 , 
  
 callback 
 : 
  
 JobCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    source Table | Table []
    metadata CopyTableMetadata
    callback JobCallback
    Returns
    Type Description
    void

    createCopyFromJob(source, callback)

      createCopyFromJob 
 ( 
 source 
 : 
  
 Table 
  
 | 
  
 Table 
 [], 
  
 callback 
 : 
  
 JobCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    source Table | Table []
    callback JobCallback
    Returns
    Type Description
    void

    createCopyJob(destination, metadata)

      createCopyJob 
 ( 
 destination 
 : 
  
 Table 
 , 
  
 metadata 
 ?: 
  
 CreateCopyJobMetadata 
 ) 
 : 
  
 Promise<JobResponse> 
 ;
    Parameters
    Name Description
    destination Table
    metadata CreateCopyJobMetadata
    Returns
    Type Description
    Promise < JobResponse >

    createCopyJob(destination, metadata, callback)

      createCopyJob 
 ( 
 destination 
 : 
  
 Table 
 , 
  
 metadata 
 : 
  
 CreateCopyJobMetadata 
 , 
  
 callback 
 : 
  
 JobCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    destination Table
    metadata CreateCopyJobMetadata
    callback JobCallback
    Returns
    Type Description
    void

    createCopyJob(destination, callback)

      createCopyJob 
 ( 
 destination 
 : 
  
 Table 
 , 
  
 callback 
 : 
  
 JobCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    destination Table
    callback JobCallback
    Returns
    Type Description
    void

    createExtractJob(destination, options)

      createExtractJob 
 ( 
 destination 
 : 
  
 File 
 , 
  
 options 
 ?: 
  
 CreateExtractJobOptions 
 ) 
 : 
  
 Promise<JobResponse> 
 ;
    Parameters
    Name Description
    destination File
    options CreateExtractJobOptions
    Returns
    Type Description
    Promise < JobResponse >

    createExtractJob(destination, options, callback)

      createExtractJob 
 ( 
 destination 
 : 
  
 File 
 , 
  
 options 
 : 
  
 CreateExtractJobOptions 
 , 
  
 callback 
 : 
  
 JobCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    destination File
    options CreateExtractJobOptions
    callback JobCallback
    Returns
    Type Description
    void

    createExtractJob(destination, callback)

      createExtractJob 
 ( 
 destination 
 : 
  
 File 
 , 
  
 callback 
 : 
  
 JobCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    destination File
    callback JobCallback
    Returns
    Type Description
    void

    createLoadJob(source, metadata)

      createLoadJob 
 ( 
 source 
 : 
  
 string 
  
 | 
  
 File 
 , 
  
 metadata 
 ?: 
  
 JobLoadMetadata 
 ) 
 : 
  
 Promise<JobResponse> 
 ;
    Parameters
    Name Description
    source string | File
    metadata JobLoadMetadata
    Returns
    Type Description
    Promise < JobResponse >

    createLoadJob(source, metadata, callback)

      createLoadJob 
 ( 
 source 
 : 
  
 string 
  
 | 
  
 File 
 , 
  
 metadata 
 : 
  
 JobLoadMetadata 
 , 
  
 callback 
 : 
  
 JobCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    source string | File
    metadata JobLoadMetadata
    callback JobCallback
    Returns
    Type Description
    void

    createLoadJob(source, callback)

      createLoadJob 
 ( 
 source 
 : 
  
 string 
  
 | 
  
 File 
 , 
  
 callback 
 : 
  
 JobCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    source string | File
    callback JobCallback
    Returns
    Type Description
    void

    createQueryJob(options)

      createQueryJob 
 ( 
 options 
 : 
  
 Query 
 ) 
 : 
  
 Promise<JobResponse> 
 ;
    Parameter
    Name Description
    options Query
    Returns
    Type Description
    Promise < JobResponse >

    createQueryJob(options, callback)

      createQueryJob 
 ( 
 options 
 : 
  
 Query 
 , 
  
 callback 
 : 
  
 JobCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    options Query
    callback JobCallback
    Returns
    Type Description
    void

    createQueryStream(query)

      createQueryStream 
 ( 
 query 
 : 
  
 Query 
 ) 
 : 
  
 Duplex 
 ;

    Run a query scoped to your dataset as a readable object stream.

    See for full documentation of this method.

    Parameter
    Name Description
    query Query

    See for full documentation of this method.
    Returns
    Type Description
    Duplex

    {stream} See for full documentation of this method.

    createSchemaFromString_(str)

      static 
  
 createSchemaFromString_ 
 ( 
 str 
 : 
  
 string 
 ) 
 : 
  
 TableSchema 
 ;

    Convert a comma-separated name:type string to a table schema object.

    Parameter
    Name Description
    str string

    Comma-separated schema string.
    Returns
    Type Description
    TableSchema

    {object} Table schema in the format the API expects.

    createWriteStream_(metadata)

      createWriteStream_ 
 ( 
 metadata 
 : 
  
 JobLoadMetadata 
  
 | 
  
 string 
 ) 
 : 
  
 Writable 
 ;

    Creates a write stream. Unlike the public version, this will not automatically poll the underlying job.

    Parameter
    Name Description
    metadata JobLoadMetadata | string

    Metadata to set with the load operation. The metadata object should be in the format of the [ configuration.load ](https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationLoad) property of a Jobs resource. If a string is given, it will be used as the filetype.
    Returns
    Type Description
    Writable

    {WritableStream}

    createWriteStream(metadata)

      createWriteStream 
 ( 
 metadata 
 : 
  
 JobLoadMetadata 
  
 | 
  
 string 
 ) 
 : 
  
 Writable 
 ;

    Load data into your table from a readable stream of AVRO, CSV, JSON, ORC, or PARQUET data.

    [Jobs: insert API Documentation] https://cloud.google.com/bigquery/docs/reference/v2/jobs/insert

    Parameter
    Name Description
    metadata JobLoadMetadata | string

    Metadata to set with the load operation. The metadata object should be in the format of the [ configuration.load ](https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationLoad) property of a Jobs resource. If a string is given, it will be used as the filetype.
    Returns
    Type Description
    Writable

    {WritableStream}

    encodeValue_(value)

      static 
  
 encodeValue_ 
 ( 
 value 
 ?: 
  
 {} 
  
 | 
  
 null 
 ) 
 : 
  
 {} 
  
 | 
  
 null 
 ;

    Convert a row entry from native types to their encoded types that the API expects.

    Parameter
    Name Description
    value {} | null

    The value to be converted.
    Returns
    Type Description
    {} | null

    {*} The converted value.

    extract(destination, options)

      extract 
 ( 
 destination 
 : 
  
 File 
 , 
  
 options 
 ?: 
  
 CreateExtractJobOptions 
 ) 
 : 
  
 Promise<JobMetadataResponse> 
 ;
    Parameters
    Name Description
    destination File
    options CreateExtractJobOptions
    Returns
    Type Description
    Promise < JobMetadataResponse >

    extract(destination, options, callback)

      extract 
 ( 
 destination 
 : 
  
 File 
 , 
  
 options 
 : 
  
 CreateExtractJobOptions 
 , 
  
 callback 
 ?: 
  
 JobMetadataCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    destination File
    options CreateExtractJobOptions
    callback JobMetadataCallback
    Returns
    Type Description
    void

    extract(destination, callback)

      extract 
 ( 
 destination 
 : 
  
 File 
 , 
  
 callback 
 ?: 
  
 JobMetadataCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    destination File
    callback JobMetadataCallback
    Returns
    Type Description
    void

    formatMetadata_(options)

      static 
  
 formatMetadata_ 
 ( 
 options 
 : 
  
 TableMetadata 
 ) 
 : 
  
 FormattedMetadata 
 ;
    Parameter
    Name Description
    options TableMetadata
    Returns
    Type Description
    FormattedMetadata

    getIamPolicy(optionsOrCallback)

      getIamPolicy 
 ( 
 optionsOrCallback 
 ?: 
  
 GetPolicyOptions 
  
 | 
  
 PolicyCallback 
 ) 
 : 
  
 Promise<PolicyResponse> 
 ;
    Parameter
    Name Description
    optionsOrCallback GetPolicyOptions | PolicyCallback
    Returns
    Type Description
    Promise < PolicyResponse >

    getIamPolicy(options, callback)

      getIamPolicy 
 ( 
 options 
 : 
  
 GetPolicyOptions 
 , 
  
 callback 
 : 
  
 PolicyCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    options GetPolicyOptions
    callback PolicyCallback
    Returns
    Type Description
    void

    getRows(options)

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

    getRows(options, callback)

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

    getRows(callback)

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

    insert(rows, options)

      insert 
 ( 
 rows 
 : 
  
 RowMetadata 
  
 | 
  
 RowMetadata 
 [], 
  
 options 
 ?: 
  
 InsertRowsOptions 
 ) 
 : 
  
 Promise<InsertRowsResponse> 
 ;
    Parameters
    Name Description
    rows RowMetadata | RowMetadata []
    options InsertRowsOptions
    Returns
    Type Description
    Promise < InsertRowsResponse >

    insert(rows, options, callback)

      insert 
 ( 
 rows 
 : 
  
 RowMetadata 
  
 | 
  
 RowMetadata 
 [], 
  
 options 
 : 
  
 InsertRowsOptions 
 , 
  
 callback 
 : 
  
 InsertRowsCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    rows RowMetadata | RowMetadata []
    options InsertRowsOptions
    callback InsertRowsCallback
    Returns
    Type Description
    void

    insert(rows, callback)

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

    load(source, metadata)

      load 
 ( 
 source 
 : 
  
 string 
  
 | 
  
 File 
 , 
  
 metadata 
 ?: 
  
 JobLoadMetadata 
 ) 
 : 
  
 Promise<JobMetadataResponse> 
 ;
    Parameters
    Name Description
    source string | File
    metadata JobLoadMetadata
    Returns
    Type Description
    Promise < JobMetadataResponse >

    load(source, metadata, callback)

      load 
 ( 
 source 
 : 
  
 string 
  
 | 
  
 File 
 , 
  
 metadata 
 : 
  
 JobLoadMetadata 
 , 
  
 callback 
 : 
  
 JobMetadataCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    source string | File
    metadata JobLoadMetadata
    callback JobMetadataCallback
    Returns
    Type Description
    void

    load(source, callback)

      load 
 ( 
 source 
 : 
  
 string 
  
 | 
  
 File 
 , 
  
 callback 
 : 
  
 JobMetadataCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    source string | File
    callback JobMetadataCallback
    Returns
    Type Description
    void

    query(query)

      query 
 ( 
 query 
 : 
  
 Query 
 ) 
 : 
  
 Promise<SimpleQueryRowsResponse> 
 ;
    Parameter
    Name Description
    query Query
    Returns
    Type Description
    Promise < SimpleQueryRowsResponse >

    query(query, callback)

      query 
 ( 
 query 
 : 
  
 Query 
 , 
  
 callback 
 : 
  
 SimpleQueryRowsCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    query Query
    callback SimpleQueryRowsCallback
    Returns
    Type Description
    void

    setIamPolicy(policy, options)

      setIamPolicy 
 ( 
 policy 
 : 
  
 Policy 
 , 
  
 options 
 ?: 
  
 SetPolicyOptions 
 ) 
 : 
  
 Promise<PolicyResponse> 
 ;
    Parameters
    Name Description
    policy Policy
    options SetPolicyOptions
    Returns
    Type Description
    Promise < PolicyResponse >

    setIamPolicy(policy, options, callback)

      setIamPolicy 
 ( 
 policy 
 : 
  
 Policy 
 , 
  
 options 
 : 
  
 SetPolicyOptions 
 , 
  
 callback 
 : 
  
 PolicyCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    policy Policy
    options SetPolicyOptions
    callback PolicyCallback
    Returns
    Type Description
    void

    setIamPolicy(policy, callback)

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

    setMetadata(metadata)

      setMetadata 
 ( 
 metadata 
 : 
  
 SetTableMetadataOptions 
 ) 
 : 
  
 Promise<common 
 . 
 SetMetadataResponse 
> ;
    Parameter
    Name Description
    metadata SetTableMetadataOptions
    Returns
    Type Description
    Promise <common. SetMetadataResponse >

    setMetadata(metadata, callback)

      setMetadata 
 ( 
 metadata 
 : 
  
 SetTableMetadataOptions 
 , 
  
 callback 
 : 
  
 common 
 . 
 ResponseCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    metadata SetTableMetadataOptions
    callback common. ResponseCallback
    Returns
    Type Description
    void

    testIamPermissions(permissions)

      testIamPermissions 
 ( 
 permissions 
 : 
  
 string 
  
 | 
  
 string 
 []) 
 : 
  
 Promise<PermissionsResponse> 
 ;
    Parameter
    Name Description
    permissions string | string[]
    Returns
    Type Description
    Promise < PermissionsResponse >

    testIamPermissions(permissions, callback)

      testIamPermissions 
 ( 
 permissions 
 : 
  
 string 
  
 | 
  
 string 
 [], 
  
 callback 
 : 
  
 PermissionsCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    permissions string | string[]
    callback PermissionsCallback
    Returns
    Type Description
    void
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: