Class TableServiceClient
The client encapsulates the URL for the Tables service endpoint and the credentials for accessing the storage or CosmosDB table API account. It provides methods to create, delete, and list tables within the account. These methods invoke REST API operations to make the requests and obtain the results that are returned.
Instances of this client are obtained by calling the TableServiceClientBuilder.buildClient()
method on a
TableServiceClientBuilder
object.
Samples to construct a sync client
TableServiceClient tableServiceClient = new TableServiceClientBuilder() .endpoint("https://myvault.azure.net/") .credential(new AzureNamedKeyCredential("name", "key")) .buildClient();
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptioncreateTable
(String tableName) Creates a table within the Tables service.createTableIfNotExists
(String tableName) Creates a table within the Tables service if the table does not already exist.createTableIfNotExistsWithResponse
(String tableName, Duration timeout, Context context) Creates a table within the Tables service if the table does not already exist.createTableWithResponse
(String tableName, Duration timeout, Context context) Creates a table within the Tables service.void
deleteTable
(String tableName) Deletes a table within the Tables service.deleteTableWithResponse
(String tableName, Duration timeout, Context context) Deletes a table within the Tables service.generateAccountSas
(TableAccountSasSignatureValues tableAccountSasSignatureValues) Generates an account SAS for the Azure Storage account using the specifiedTableAccountSasSignatureValues
.Gets the name of the account containing the table.Gets the properties of the account's Table service, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.getPropertiesWithResponse
(Duration timeout, Context context) Gets the properties of the account's Table service, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.Gets the endpoint for the Tables service.Gets the REST API version used by this client.Retrieves statistics related to replication for the account's Table service.getStatisticsWithResponse
(Duration timeout, Context context) Retrieves statistics related to replication for the account's Table service.getTableClient
(String tableName) Gets aTableClient
instance for the table in the account with the providedtableName
.Lists all tables within the account.listTables
(ListTablesOptions options, Duration timeout, Context context) If thefilter
parameter in the options is set, only tables matching the filter will be returned.void
setProperties
(TableServiceProperties tableServiceProperties) Sets the properties of the account's Table service, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.setPropertiesWithResponse
(TableServiceProperties tableServiceProperties, Duration timeout, Context context) Sets the properties of an account's Table service, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.
-
Method Details
-
getAccountName
Gets the name of the account containing the table.- Returns:
- The name of the account containing the table.
-
getServiceEndpoint
Gets the endpoint for the Tables service.- Returns:
- The endpoint for the Tables service.
-
getServiceVersion
Gets the REST API version used by this client.- Returns:
- The REST API version used by this client.
-
generateAccountSas
Generates an account SAS for the Azure Storage account using the specifiedTableAccountSasSignatureValues
.Note: The client must be authenticated via
AzureNamedKeyCredential
.See
TableAccountSasSignatureValues
for more information on how to construct an account SAS.- Parameters:
tableAccountSasSignatureValues
-TableAccountSasSignatureValues
.- Returns:
- A
String
representing the SAS query parameters. - Throws:
IllegalStateException
- If thisTableClient
is not authenticated with anAzureNamedKeyCredential
.
-
getTableClient
Gets aTableClient
instance for the table in the account with the providedtableName
. The resultingTableClient
will use the samepipeline
andservice version
as thisTableServiceClient
.- Parameters:
tableName
- The name of the table.- Returns:
- A
TableClient
instance for the table in the account with the providedtableName
. - Throws:
IllegalArgumentException
- IftableName
isnull
or empty.
-
createTable
Creates a table within the Tables service.Code Samples
Creates a table. Prints out the details of the created table.
TableClient tableClient = tableServiceClient.createTable("myTable"); System.out.printf("Table with name '%s' was created.", tableClient.getTableName());
- Parameters:
tableName
- The name of the table to create.- Returns:
- A
TableClient
for the created table. - Throws:
IllegalArgumentException
- IftableName
isnull
or empty.TableServiceException
- If a table with the same name already exists within the service.
-
createTableWithResponse
public Response<TableClient> createTableWithResponse(String tableName, Duration timeout, Context context) Creates a table within the Tables service.Code Samples
Creates a table. Prints out the details of the
HTTP response
and the created table.Response<TableClient> response = tableServiceClient.createTableWithResponse("myTable", Duration.ofSeconds(5), new Context("key1", "value1")); System.out.printf("Response successful with status code: %d. Table with name '%s' was created.", response.getStatusCode(), response.getValue().getTableName());
- Parameters:
tableName
- The name of the table to create.timeout
- An optional timeout value beyond which aRuntimeException
will be raised.context
- AdditionalContext
that is passed through theHTTP pipeline
during the service call.- Returns:
- The
HTTP response
containing aTableClient
for the created table. - Throws:
IllegalArgumentException
- IftableName
isnull
or empty.TableServiceException
- If a table with the same name already exists within the service.
-
createTableIfNotExists
Creates a table within the Tables service if the table does not already exist.Code Samples
Creates a table if it does not already exist. Prints out the details of the created table.
TableClient tableClient = tableServiceClient.createTableIfNotExists("myTable"); System.out.printf("Table with name '%s' was created.", tableClient.getTableName());
- Parameters:
tableName
- The name of the table to create.- Returns:
- A
TableClient
for the created table. - Throws:
IllegalArgumentException
- IftableName
isnull
or empty.
-
createTableIfNotExistsWithResponse
public Response<TableClient> createTableIfNotExistsWithResponse(String tableName, Duration timeout, Context context) Creates a table within the Tables service if the table does not already exist.Code Samples
Creates a table if it does not already exist. Prints out the details of the
HTTP response
and the created table.Response<TableClient> response = tableServiceClient.createTableIfNotExistsWithResponse("myTable", Duration.ofSeconds(5), new Context("key1", "value1")); System.out.printf("Response successful with status code: %d. Table with name '%s' was created.", response.getStatusCode(), response.getValue().getTableName());
- Parameters:
tableName
- The name of the table to create.timeout
- An optional timeout value beyond which aRuntimeException
will be raised.context
- AdditionalContext
that is passed through theHTTP pipeline
during the service call.- Returns:
- The
HTTP response
containing aTableClient
for the created table. - Throws:
IllegalArgumentException
- IftableName
isnull
or empty.
-
deleteTable
Deletes a table within the Tables service.Code Samples
Deletes a table.
String tableName = "myTable"; tableServiceClient.deleteTable(tableName); System.out.printf("Table with name '%s' was deleted.", tableName);
- Parameters:
tableName
- The name of the table to delete.- Throws:
IllegalArgumentException
- IftableName
isnull
or empty.TableServiceException
- If the request is rejected by the service.
-
deleteTableWithResponse
Deletes a table within the Tables service.Code Samples
Deletes a table. Prints out the details of the
HTTP response
.String myTableName = "myTable"; Response<Void> response = tableServiceClient.deleteTableWithResponse(myTableName, Duration.ofSeconds(5), new Context("key1", "value1")); System.out.printf("Response successful with status code: %d. Table with name '%s' was deleted.", response.getStatusCode(), myTableName);
- Parameters:
tableName
- The name of the table to delete.timeout
- An optional timeout value beyond which aRuntimeException
will be raised.context
- AdditionalContext
that is passed through theHTTP pipeline
during the service call.- Returns:
- The
HTTP response
. - Throws:
IllegalArgumentException
- IftableName
isnull
or empty.TableServiceException
- If the request is rejected by the service.
-
listTables
Lists all tables within the account.Code Samples
Lists all tables. Prints out the details of the retrieved tables.
PagedIterable<TableItem> tableItems = tableServiceClient.listTables(); tableItems.forEach(tableItem -> System.out.printf("Retrieved table with name '%s'.%n", tableItem.getName()));
- Returns:
- A
PagedIterable
containing all tables within the account. - Throws:
TableServiceException
- If the request is rejected by the service.
-
listTables
public PagedIterable<TableItem> listTables(ListTablesOptions options, Duration timeout, Context context) If thefilter
parameter in the options is set, only tables matching the filter will be returned. If thetop
parameter is set, the maximum number of returned tables per page will be limited to that value.Code Samples
Lists all tables that match the filter. Prints out the details of the retrieved tables.
ListTablesOptions options = new ListTablesOptions().setFilter("TableName eq 'myTable'"); PagedIterable<TableItem> retrievedTableItems = tableServiceClient.listTables(options, Duration.ofSeconds(5), new Context("key1", "value1")); retrievedTableItems.forEach(tableItem -> System.out.printf("Retrieved table with name '%s'.%n", tableItem.getName()));
- Parameters:
options
- Thefilter
andtop
OData query options to apply to this operation.timeout
- An optional timeout value beyond which aRuntimeException
will be raised.context
- AdditionalContext
that is passed through theHTTP pipeline
during the service call.- Returns:
- A
PagedIterable
containing matching tables within the account. - Throws:
IllegalArgumentException
- If one or more of the OData query options inoptions
is malformed.TableServiceException
- If the request is rejected by the service.
-
getProperties
Gets the properties of the account's Table service, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.This operation is only supported on Azure Storage endpoints.
Code Samples
Gets the properties of the account's Table service.
TableServiceProperties properties = tableServiceClient.getProperties(); System.out.print("Retrieved service properties successfully.");
- Returns:
- The
properties
of the account's Table service. - Throws:
TableServiceException
- If the request is rejected by the service.
-
getPropertiesWithResponse
public Response<TableServiceProperties> getPropertiesWithResponse(Duration timeout, Context context) Gets the properties of the account's Table service, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.This operation is only supported on Azure Storage endpoints.
Code Samples
Gets the properties of the account's Table service. Prints out the details of the
HTTP response
.Response<TableServiceProperties> response = tableServiceClient.getPropertiesWithResponse(Duration.ofSeconds(5), new Context("key1", "value1")); System.out.printf("Retrieved service properties successfully with status code: %d.", response.getStatusCode());
- Parameters:
timeout
- An optional timeout value beyond which aRuntimeException
will be raised.context
- AdditionalContext
that is passed through theHTTP pipeline
during the service call.- Returns:
- The
HTTP response
and theproperties
of the account's Table service. - Throws:
TableServiceException
- If the request is rejected by the service.
-
setProperties
Sets the properties of the account's Table service, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.This operation is only supported on Azure Storage endpoints.
Code Samples
Sets the properties of the account's Table service.
TableServiceProperties properties = new TableServiceProperties() .setHourMetrics(new TableServiceMetrics() .setVersion("1.0") .setEnabled(true)) .setLogging(new TableServiceLogging() .setAnalyticsVersion("1.0") .setReadLogged(true) .setRetentionPolicy(new TableServiceRetentionPolicy() .setEnabled(true) .setDaysToRetain(5))); tableServiceClient.setProperties(properties); System.out.print("Set service properties successfully.");
- Parameters:
tableServiceProperties
- TheTableServiceProperties
to set.- Throws:
TableServiceException
- If the request is rejected by the service.
-
setPropertiesWithResponse
public Response<Void> setPropertiesWithResponse(TableServiceProperties tableServiceProperties, Duration timeout, Context context) Sets the properties of an account's Table service, including properties for Analytics and CORS (Cross-Origin Resource Sharing) rules.This operation is only supported on Azure Storage endpoints.
Code Samples
Sets the properties of the account's Table service. Prints out the details of the
HTTP response
.TableServiceProperties myProperties = new TableServiceProperties() .setHourMetrics(new TableServiceMetrics() .setVersion("1.0") .setEnabled(true)) .setLogging(new TableServiceLogging() .setAnalyticsVersion("1.0") .setReadLogged(true) .setRetentionPolicy(new TableServiceRetentionPolicy() .setEnabled(true) .setDaysToRetain(5))); Response<Void> response = tableServiceClient.setPropertiesWithResponse(myProperties, Duration.ofSeconds(5), new Context("key1", "value1")); System.out.printf("Retrieved service properties successfully with status code: %d.", response.getStatusCode());
- Parameters:
tableServiceProperties
- TheTableServiceProperties
to set.timeout
- An optional timeout value beyond which aRuntimeException
will be raised.context
- AdditionalContext
that is passed through theHTTP pipeline
during the service call.- Returns:
- The
HTTP response
. - Throws:
TableServiceException
- If the request is rejected by the service.
-
getStatistics
Retrieves statistics related to replication for the account's Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the account.This operation is only supported on Azure Storage endpoints.
Code Samples
Gets the replication statistics of the account's Table service.
TableServiceStatistics statistics = tableServiceClient.getStatistics(); System.out.print("Retrieved service statistics successfully.");
- Returns:
Statistics
for the account's Table service.- Throws:
TableServiceException
- If the request is rejected by the service.
-
getStatisticsWithResponse
public Response<TableServiceStatistics> getStatisticsWithResponse(Duration timeout, Context context) Retrieves statistics related to replication for the account's Table service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the account.This operation is only supported on Azure Storage endpoints.
Code Samples
Gets the replication statistics of the account's Table service. Prints out the details of the
HTTP response
.Response<TableServiceStatistics> response = tableServiceClient.getStatisticsWithResponse(Duration.ofSeconds(5), new Context("key1", "value1")); System.out.printf("Retrieved service statistics successfully with status code: %d.", response.getStatusCode());
- Parameters:
timeout
- An optional timeout value beyond which aRuntimeException
will be raised.context
- AdditionalContext
that is passed through theHTTP pipeline
during the service call.- Returns:
- An
HTTP response
containingstatistics
for the account's Table service. - Throws:
TableServiceException
- If the request is rejected by the service.
-