Alter a Table
put
/20190828/tables/{tableNameOrId}
Alter a table identified by tableNameOrId,
changing schema, limits, or tags
Request
Path Parameters
-
tableNameOrId: string
A table name within the compartment, or a table OCID.
Header Parameters
-
if-match(optional): string(base64)
For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.Default Value:
false
-
opc-request-id: string
The client request ID for tracing.
Specifications for the alteration.
Root Schema : UpdateTableDetails
Type:
object
The information to be updated.
Show Source
-
compartmentId(optional):
string
The OCID of the table's current compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and compartmentId is supplied, the latter must match the identified table's compartmentId.
-
ddlStatement(optional):
string
Complete ALTER TABLE DDL statement.
-
definedTags(optional):
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
-
freeformTags(optional):
object freeformTags
Additional Properties Allowed: additionalPropertiesSimple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
-
tableLimits(optional):
object TableLimits
Throughput and storage limits configuration of a table.
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`
Defined tags for this resource. Each key is predefined and
scoped to a namespace. Example: `{"foo-namespace":
{"bar-key": "value"}}`
Nested Schema : freeformTags
Type:
object
Additional Properties Allowed
Show Source
Simple key-value pair that is applied without any predefined
name, type or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
Nested Schema : TableLimits
Type:
object
Throughput and storage limits configuration of a table.
Show Source
-
maxReadUnits:
integer
Maximum sustained read throughput limit for the table.
-
maxStorageInGBs:
integer
Maximum size of storage used by the table.
-
maxWriteUnits:
integer
Maximum sustained write throughput limit for the table.
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
The value of the tag. Only string, integer and boolean types are supported.
Key-value pair representing predefined tags' keys and values
scoped to a namespace. Example: `{"bar-key": "value"}`
Nested Schema : additionalProperties
Type:
object
The value of the tag. Only string, integer and boolean
types are supported.
Response
Supported Media Types
- application/json
202 Response
Accepted the request. The table will be updated.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
-
opc-work-request-id: string
Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code:
string
A short error code that defines the error, meant for programmatic parsing.
-
message:
string
A human-readable error string.
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code:
string
A short error code that defines the error, meant for programmatic parsing.
-
message:
string
A human-readable error string.
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code:
string
A short error code that defines the error, meant for programmatic parsing.
-
message:
string
A human-readable error string.
412 Response
Precondition failed
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code:
string
A short error code that defines the error, meant for programmatic parsing.
-
message:
string
A human-readable error string.
429 Response
Too Many Requests
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
-
retry-after: number(float)
A decimal number representing the number of seconds the client should wait before polling this endpoint again.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code:
string
A short error code that defines the error, meant for programmatic parsing.
-
message:
string
A human-readable error string.
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code:
string
A short error code that defines the error, meant for programmatic parsing.
-
message:
string
A human-readable error string.
Default Response
Unknown Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
Error Information.
Show Source
-
code:
string
A short error code that defines the error, meant for programmatic parsing.
-
message:
string
A human-readable error string.