ITableLocator.LocateTable(TableInfo, RequestOptions) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides a way to adjust table and request parameters for a specified request.
public:
Nullable<System::Cloud::DocumentDb::TableInfo> LocateTable(System::Cloud::DocumentDb::TableInfo ^ options, System::Cloud::DocumentDb::RequestOptions ^ request);public System.Cloud.DocumentDb.TableInfo? LocateTable(in System.Cloud.DocumentDb.TableInfo options, System.Cloud.DocumentDb.RequestOptions request);abstract member LocateTable : TableInfo * System.Cloud.DocumentDb.RequestOptions -> Nullable<System.Cloud.DocumentDb.TableInfo>Public Function LocateTable (options As TableInfo, request As RequestOptions) As Nullable(Of TableInfo)Parameters
- options
- TableInfo
The original table options.
- request
- RequestOptions
The target request.
Returns
A new table options, or the input options if no adjustments are needed.
Remarks
This method will be called only in cases IsLocatorRequired is set to true. The input table options should not be modified; those are original options used to initialize reader / writer. The method can adjust table name, region in request, or other options specific to the provided document or request. For example: - A specific region might have a different table name, throughput requirements, or TTL. - A specific document might have a region or table requirement different from original. Notes: - The request object is not shared between calls; it can be modified by the method directly. - The request is the same provided for the API call. If a document is needed to implement locate logic, use RequestOptions<TDocument> for requests.
