Creates a draft tree schema for the destination database.
HTTP request
POST https://datamigration.googleapis.com/v1/{name}:convert
Path parameters
Parameters
name
string
Name of the conversion workspace resource to convert in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversionWorkspace}.
Request body
The request body contains data with the following structure:
Optional. Specifies whether the conversion workspace is to be committed automatically after the conversion.
filter
string
Optional. Filter the entities to convert. Leaving this field empty will convert all of the entities. Supports Google AIP-160 style filtering.
convertFullPath
boolean
Optional. Automatically convert the full entity path for each entity specified by the filter. For example, if the filter specifies a table, that table schema (and database if there is one) will also be converted.
Response body
If successful, the response body contains an instance of Operation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["\u003cp\u003eThis endpoint facilitates the conversion of a database schema by creating a draft tree schema for the destination database.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a POST method to the specified URL, requiring a path parameter \u003ccode\u003ename\u003c/code\u003e representing the conversion workspace resource.\u003c/p\u003e\n"],["\u003cp\u003eThe request body allows for optional configurations such as \u003ccode\u003eautoCommit\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e to select specific entities, and \u003ccode\u003econvertFullPath\u003c/code\u003e to convert entire entity paths.\u003c/p\u003e\n"],["\u003cp\u003eA successful request will return an instance of the Operation resource, providing details about the database schema conversion process.\u003c/p\u003e\n"],["\u003cp\u003eThe endpoint requires OAuth scope: \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e to be authorized.\u003c/p\u003e\n"]]],[],null,[]]
