Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class DatabaseTableReference.
Message representing a table including its schema.
Generated from protobuf message google.cloud.geminidataanalytics.v1beta.DatabaseTableReference
Namespace
Google \ Cloud \ GeminiDataAnalytics \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ table_id |
string
Required. The name of the table as defined in the database. Note: The precise rules for table naming, including valid characters, length limits, and case sensitivity, are determined by the specific database system. Requirements: - Exact Match: The provided name must be identical to the name stored in the database. - Case Sensitivity: Respect the case sensitivity rules of the specific database system and how the table was created. For example, "Orders" and "orders" may be distinct table names. - Special Characters/Keywords: If the table name includes spaces, special characters, or is a database reserved keyword, provide the literal name as it is stored. Do not add any database-specific identifier quoting characters (e.g., ", `, []). Examples: - Simple name: "orders", "UserActivity" - Case sensitive: "MyTable" - Name with spaces: "Order Details" - Name with other special characters: "user/data", "order-items" - Name that is a keyword: "Group", "Order" Permissions: The caller's credentials must have the necessary database permissions to access the table's schema and data. |
↳ schema |
Schema
Optional. The schema of the table. |
getTableId
Required. The name of the table as defined in the database.
Note: The precise rules for table naming, including valid characters, length limits, and case sensitivity, are determined by the specific database system. Requirements:
- Exact Match: The provided name must be identical to the name stored in the database.
- Case Sensitivity: Respect the case sensitivity rules of the specific database system and how the table was created. For example, "Orders" and "orders" may be distinct table names.
- Special Characters/Keywords: If the table name includes spaces, special
characters, or is a database reserved keyword, provide the literal name
as it is stored. Do not add any database-specific identifier quoting
characters (e.g., ", `, []).
Examples:
- Simple name: "orders", "UserActivity"
- Case sensitive: "MyTable"
- Name with spaces: "Order Details"
- Name with other special characters: "user/data", "order-items"
- Name that is a keyword: "Group", "Order" Permissions: The caller's credentials must have the necessary database permissions to access the table's schema and data.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTableId
Required. The name of the table as defined in the database.
Note: The precise rules for table naming, including valid characters, length limits, and case sensitivity, are determined by the specific database system. Requirements:
- Exact Match: The provided name must be identical to the name stored in the database.
- Case Sensitivity: Respect the case sensitivity rules of the specific database system and how the table was created. For example, "Orders" and "orders" may be distinct table names.
- Special Characters/Keywords: If the table name includes spaces, special
characters, or is a database reserved keyword, provide the literal name
as it is stored. Do not add any database-specific identifier quoting
characters (e.g., ", `, []).
Examples:
- Simple name: "orders", "UserActivity"
- Case sensitive: "MyTable"
- Name with spaces: "Order Details"
- Name with other special characters: "user/data", "order-items"
- Name that is a keyword: "Group", "Order" Permissions: The caller's credentials must have the necessary database permissions to access the table's schema and data.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSchema
Optional. The schema of the table.
| Returns | |
|---|---|
| Type | Description |
Schema|null |
|
hasSchema
clearSchema
setSchema
Optional. The schema of the table.
| Parameter | |
|---|---|
| Name | Description |
var |
Schema
|
| Returns | |
|---|---|
| Type | Description |
$this |
|