Skip to main content
Skip table of contents

Operation: Scan

With the Scan operation, you scan the table and issue an output XML according to the set parameters. The scanning process filters the search.

For more information on other operations of the Google Cloud Storage BigTable Connector, see Google Cloud Storage BigTable Connector.

Parameters

Adapter

Main class of the adapter (do not change!)

Possible values:

de.softproject.integration.adapter.google.cloud.bigtable.storage.GoogleCloudBigtableAdapter: Main class (Default)

serviceAccountFile

Path to the JSON file that contains the Service Account Key to authenticate against Google Cloud Storage.

Possible values:

  • System path, e.g.: C:\X4\V_5.4\Server\X4DB\1\ExampleProcess\GoogleCloud\Config\serviceAccountFile.json

  • X4DB URL, e.g.:
    X4db://1/ExampleProcess/GoogleCloud/Config/serviceAccountFile.json

  • XStore URL, e.g.:
    XStore://ExampleProcess/GoogleCloud/Config/serviceAccountFile.json

projectID

ID of the project

Possible values:

ID of a Google Cloud project. Can be viewed in the Google Cloud Console.

instanceID

ID of the instance

Possible values:

ID of a Google Cloud instance. Can be viewed in the Google Cloud Console.

Note:

For more information on how to create an instance in Google BigTable, see the Google Cloud documentation:

Bigtable>Create and manage instances>Create an instance (https://cloud.google.com/bigtable/docs/creating-instance?hl=en).

tableName

This parameter is required for this operation.

Name of the table

columnFamilyName

This parameter is required for this operation.

Column family name. Groups columns with unique names.

rowKey

Row key of the row. Identifier to insert or search rows.

columnName

This parameter is required for this operation.

Column name. Used to search a specific column.

startRow

This parameter is required for this operation.

Specifies a specific line as of which the scan begins.

Possible values: rowKey row key

stopRow

This parameter is required for this operation.

Specifies a specific line at which the scan ends. The line itself no longer appears in the scan results.

Possible values: rowKey row key

scanCached

Changes the scanner caching for this scan.

Possible values: Integer

Note:

If the parameter is not set, the caching value of the hosting table is used.

scanResultSize

This parameter is required for this operation.

Sets the maximum number of scan results.

Possible values: Integer

Note:

If the two scanCached and scanResultSize prameters are set, individual server requests are limited either by the number of rows or the maximum result size, depending on which limit is reached first.

scanTimestamp

This parameter is required for this operation.

Filters by columns with a specific timestamp.

Possible values: Integer

scanMaxVersions

This parameter is required for this operation.

Limits the number of versions of each column that should be returned.

Possible values: Integer

scanCacheBlocks

This parameter is required for this operation.

Explicitly disable server-side caching for this scan.

Possible values: true / false

Status values

1

The adapter operation was executed successfully

0

The operation was not completed, but no error occurred.

-1

The operation failed due to a technical error.

Output

CODE
<Column FamilyName="FamilyNamePrimary">
	<Row rowKey="CLean employee">
        <Attribute ColumnName="Address" value="Ettlingen" timeStamp="1544603282081" />
        <Attribute ColumnName="ID" value="00005" timeStamp="1544603282081" />
    </Row>
	<Row rowKey="DEV employee">
        <Attribute ColumnName="Address" value="Ettlingen" timeStamp="1544603280340" />
        <Attribute ColumnName="Frameworks" value="Java-Hibernate" timeStamp="1544603280340" />
        <Attribute ColumnName="ID" value="00003" timeStamp="1544603280340" />
        <Attribute ColumnName="Name" value="Lorena" timeStamp="1544603280340" />
    </Row>
    <Row rowKey="HR employee">
        <Attribute ColumnName="ID" value="00002" timeStamp="1544603278048" />
        <Attribute ColumnName="Name" value="Francis Ernesto" timeStamp="1544603278048" />
        <Attribute ColumnName="Surname" value="Underwood" timeStamp="1544603278048" />
    </Row>
    <Row rowKey="IT employee">
        <Attribute ColumnName="Address" value="Karlsruhe" timeStamp="1544603276625" />
        <Attribute ColumnName="Bonus" value="Yes" timeStamp="1544603276625" />
        <Attribute ColumnName="ID" value="00001" timeStamp="1544603276625" />
        <Attribute ColumnName="Name" value="Paolo" timeStamp="1544603276625" />
        <Attribute ColumnName="Phone" value="552-968-369" timeStamp="1544603276625" />
    <Attribute ColumnName="Profession" value="System Administrator" timeStamp="1544603276625" />
        <Attribute ColumnName="Surname" value="Green" timeStamp="1544603276625" />
    </Row>
    <Row rowKey="Marketing employee">
        <Attribute ColumnName="ID" value="00004" timeStamp="1544603281175" />
    <Attribute ColumnName="Name" value="Petra" timeStamp="1544603281175" />
    </Row>
    <Row rowKey="Security employee">
        <Attribute ColumnName="Address" value="Ettlingen/Build1" timeStamp="1544603283155" />
        <Attribute ColumnName="ID" value="00006" timeStamp="1544603283155" />
        <Attribute ColumnName="Name" value="Robert" timeStamp="1544603283155" />
        <Attribute ColumnName="Permisions" value="Day-Night" timeStamp="1544603283155" />
    </Row>
</Column>
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.