[{"data":1,"prerenderedAt":1549},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fguide\u002Fapi-usage-guide":3},{"id":4,"title":5,"body":6,"description":1540,"extension":1541,"meta":1542,"navigation":1543,"path":1544,"redirect":1545,"seo":1546,"stem":1547,"__hash__":1548},"docs\u002Fdocs\u002Fguide\u002Fapi-usage-guide.md","API Usage Guide",{"type":7,"value":8,"toc":1517},"minimark",[9,13,18,29,33,39,48,52,55,61,64,72,76,81,199,205,209,294,298,308,311,327,413,417,513,516,582,586,589,604,608,756,759,763,979,983,1141,1145,1149,1182,1185,1207,1211,1312,1316,1344,1348,1432,1436,1490,1494,1513],[10,11,5],"h1",{"id":12},"api-usage-guide",[14,15,17],"h2",{"id":16},"base-url","Base URL",[19,20,25],"pre",{"className":21,"code":23,"language":24},[22],"language-text","http:\u002F\u002FYOUR_SERVER\u002Fapi\u002Fv1\u002F\n","text",[26,27,23],"code",{"__ignoreMap":28},"",[30,31,32],"p",{},"For local installations:",[19,34,37],{"className":35,"code":36,"language":24},[22],"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002F\n",[26,38,36],{"__ignoreMap":28},[30,40,41,42,47],{},"The complete API contract is available via Swagger at the ",[43,44,46],"a",{"href":45},"\u002Fdocs\u002Fapi\u002Freference","API Reference",".",[14,49,51],{"id":50},"authentication","Authentication",[30,53,54],{},"All requests require two headers:",[19,56,59],{"className":57,"code":58,"language":24},[22],"X-API-Key: YOUR_API_KEY\nX-Install-ID: YOUR_INSTALL_ID\n",[26,60,58],{"__ignoreMap":28},[30,62,63],{},"On a new installation, open DBConvert Streams once and connect your account before using API-only workflows.",[30,65,66,67,71],{},"Both values are available on the ",[68,69,70],"strong",{},"Account"," page in the app.",[14,73,75],{"id":74},"create-connections","Create connections",[77,78,80],"h3",{"id":79},"mysql","MySQL",[19,82,86],{"className":83,"code":84,"language":85,"meta":28,"style":28},"language-bash shiki shiki-themes github-light github-dark","curl -X POST \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fconnections\" \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"X-Install-ID: YOUR_INSTALL_ID\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"mysql-source\",\n    \"type\": \"mysql\",\n    \"host\": \"localhost\",\n    \"port\": 3306,\n    \"username\": \"root\",\n    \"password\": \"password\",\n    \"defaultDatabase\": \"source_db\"\n  }'\n","bash",[26,87,88,111,122,132,142,151,157,163,169,175,181,187,193],{"__ignoreMap":28},[89,90,93,97,101,105,108],"span",{"class":91,"line":92},"line",1,[89,94,96],{"class":95},"sScJk","curl",[89,98,100],{"class":99},"sj4cs"," -X",[89,102,104],{"class":103},"sZZnC"," POST",[89,106,107],{"class":103}," \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fconnections\"",[89,109,110],{"class":99}," \\\n",[89,112,114,117,120],{"class":91,"line":113},2,[89,115,116],{"class":99},"  -H",[89,118,119],{"class":103}," \"X-API-Key: YOUR_API_KEY\"",[89,121,110],{"class":99},[89,123,125,127,130],{"class":91,"line":124},3,[89,126,116],{"class":99},[89,128,129],{"class":103}," \"X-Install-ID: YOUR_INSTALL_ID\"",[89,131,110],{"class":99},[89,133,135,137,140],{"class":91,"line":134},4,[89,136,116],{"class":99},[89,138,139],{"class":103}," \"Content-Type: application\u002Fjson\"",[89,141,110],{"class":99},[89,143,145,148],{"class":91,"line":144},5,[89,146,147],{"class":99},"  -d",[89,149,150],{"class":103}," '{\n",[89,152,154],{"class":91,"line":153},6,[89,155,156],{"class":103},"    \"name\": \"mysql-source\",\n",[89,158,160],{"class":91,"line":159},7,[89,161,162],{"class":103},"    \"type\": \"mysql\",\n",[89,164,166],{"class":91,"line":165},8,[89,167,168],{"class":103},"    \"host\": \"localhost\",\n",[89,170,172],{"class":91,"line":171},9,[89,173,174],{"class":103},"    \"port\": 3306,\n",[89,176,178],{"class":91,"line":177},10,[89,179,180],{"class":103},"    \"username\": \"root\",\n",[89,182,184],{"class":91,"line":183},11,[89,185,186],{"class":103},"    \"password\": \"password\",\n",[89,188,190],{"class":91,"line":189},12,[89,191,192],{"class":103},"    \"defaultDatabase\": \"source_db\"\n",[89,194,196],{"class":91,"line":195},13,[89,197,198],{"class":103},"  }'\n",[30,200,201,204],{},[26,202,203],{},"defaultDatabase"," is optional. If omitted, the connection can access all databases on the server. Set it to scope the connection to a specific database by default.",[77,206,208],{"id":207},"postgresql","PostgreSQL",[19,210,212],{"className":83,"code":211,"language":85,"meta":28,"style":28},"curl -X POST \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fconnections\" \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"X-Install-ID: YOUR_INSTALL_ID\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"postgres-target\",\n    \"type\": \"postgresql\",\n    \"host\": \"localhost\",\n    \"port\": 5432,\n    \"username\": \"postgres\",\n    \"password\": \"postgres\",\n    \"defaultDatabase\": \"target_db\"\n  }'\n",[26,213,214,226,234,242,250,256,261,266,270,275,280,285,290],{"__ignoreMap":28},[89,215,216,218,220,222,224],{"class":91,"line":92},[89,217,96],{"class":95},[89,219,100],{"class":99},[89,221,104],{"class":103},[89,223,107],{"class":103},[89,225,110],{"class":99},[89,227,228,230,232],{"class":91,"line":113},[89,229,116],{"class":99},[89,231,119],{"class":103},[89,233,110],{"class":99},[89,235,236,238,240],{"class":91,"line":124},[89,237,116],{"class":99},[89,239,129],{"class":103},[89,241,110],{"class":99},[89,243,244,246,248],{"class":91,"line":134},[89,245,116],{"class":99},[89,247,139],{"class":103},[89,249,110],{"class":99},[89,251,252,254],{"class":91,"line":144},[89,253,147],{"class":99},[89,255,150],{"class":103},[89,257,258],{"class":91,"line":153},[89,259,260],{"class":103},"    \"name\": \"postgres-target\",\n",[89,262,263],{"class":91,"line":159},[89,264,265],{"class":103},"    \"type\": \"postgresql\",\n",[89,267,268],{"class":91,"line":165},[89,269,168],{"class":103},[89,271,272],{"class":91,"line":171},[89,273,274],{"class":103},"    \"port\": 5432,\n",[89,276,277],{"class":91,"line":177},[89,278,279],{"class":103},"    \"username\": \"postgres\",\n",[89,281,282],{"class":91,"line":183},[89,283,284],{"class":103},"    \"password\": \"postgres\",\n",[89,286,287],{"class":91,"line":189},[89,288,289],{"class":103},"    \"defaultDatabase\": \"target_db\"\n",[89,291,292],{"class":91,"line":195},[89,293,198],{"class":103},[77,295,297],{"id":296},"file-connection","File connection",[30,299,300,301,304,305,47],{},"Use ",[26,302,303],{},"type: \"files\""," for local file-based connections. The connection defines a shared base path. Output format is selected in the stream config target spec. File-source selection is defined in ",[26,306,307],{},"source.connections[].files",[30,309,310],{},"For Docker deployments, use the shared container paths:",[312,313,314,321],"ul",{},[315,316,317,320],"li",{},[26,318,319],{},"\u002Fdata\u002Fimports"," for local file sources",[315,322,323,326],{},[26,324,325],{},"\u002Fdata\u002Fexports"," for local file targets",[19,328,330],{"className":83,"code":329,"language":85,"meta":28,"style":28},"curl -X POST \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fconnections\" \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"X-Install-ID: YOUR_INSTALL_ID\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"file-connection\",\n    \"type\": \"files\",\n    \"spec\": {\n      \"files\": {\n        \"basePath\": \"\u002Fdata\u002Fexports\"\n      }\n    }\n  }'\n",[26,331,332,344,352,360,368,374,379,384,389,394,399,404,409],{"__ignoreMap":28},[89,333,334,336,338,340,342],{"class":91,"line":92},[89,335,96],{"class":95},[89,337,100],{"class":99},[89,339,104],{"class":103},[89,341,107],{"class":103},[89,343,110],{"class":99},[89,345,346,348,350],{"class":91,"line":113},[89,347,116],{"class":99},[89,349,119],{"class":103},[89,351,110],{"class":99},[89,353,354,356,358],{"class":91,"line":124},[89,355,116],{"class":99},[89,357,129],{"class":103},[89,359,110],{"class":99},[89,361,362,364,366],{"class":91,"line":134},[89,363,116],{"class":99},[89,365,139],{"class":103},[89,367,110],{"class":99},[89,369,370,372],{"class":91,"line":144},[89,371,147],{"class":99},[89,373,150],{"class":103},[89,375,376],{"class":91,"line":153},[89,377,378],{"class":103},"    \"name\": \"file-connection\",\n",[89,380,381],{"class":91,"line":159},[89,382,383],{"class":103},"    \"type\": \"files\",\n",[89,385,386],{"class":91,"line":165},[89,387,388],{"class":103},"    \"spec\": {\n",[89,390,391],{"class":91,"line":171},[89,392,393],{"class":103},"      \"files\": {\n",[89,395,396],{"class":91,"line":177},[89,397,398],{"class":103},"        \"basePath\": \"\u002Fdata\u002Fexports\"\n",[89,400,401],{"class":91,"line":183},[89,402,403],{"class":103},"      }\n",[89,405,406],{"class":91,"line":189},[89,407,408],{"class":103},"    }\n",[89,410,411],{"class":91,"line":195},[89,412,198],{"class":103},[77,414,416],{"id":415},"s3-storage","S3 storage",[19,418,420],{"className":83,"code":419,"language":85,"meta":28,"style":28},"curl -X POST \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fconnections\" \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"X-Install-ID: YOUR_INSTALL_ID\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"s3-csv-export\",\n    \"type\": \"files\",\n    \"file_format\": \"csv\",\n    \"storage_config\": {\n      \"provider\": \"s3\",\n      \"uri\": \"s3:\u002F\u002Fmy-bucket\u002Fexports\u002Fcsv\u002F\",\n      \"region\": \"us-east-1\",\n      \"credentials_ref\": \"secret\u002Fdata\u002Faws\u002Fmy-bucket\"\n    }\n  }'\n",[26,421,422,434,442,450,458,464,469,473,478,483,488,493,498,503,508],{"__ignoreMap":28},[89,423,424,426,428,430,432],{"class":91,"line":92},[89,425,96],{"class":95},[89,427,100],{"class":99},[89,429,104],{"class":103},[89,431,107],{"class":103},[89,433,110],{"class":99},[89,435,436,438,440],{"class":91,"line":113},[89,437,116],{"class":99},[89,439,119],{"class":103},[89,441,110],{"class":99},[89,443,444,446,448],{"class":91,"line":124},[89,445,116],{"class":99},[89,447,129],{"class":103},[89,449,110],{"class":99},[89,451,452,454,456],{"class":91,"line":134},[89,453,116],{"class":99},[89,455,139],{"class":103},[89,457,110],{"class":99},[89,459,460,462],{"class":91,"line":144},[89,461,147],{"class":99},[89,463,150],{"class":103},[89,465,466],{"class":91,"line":153},[89,467,468],{"class":103},"    \"name\": \"s3-csv-export\",\n",[89,470,471],{"class":91,"line":159},[89,472,383],{"class":103},[89,474,475],{"class":91,"line":165},[89,476,477],{"class":103},"    \"file_format\": \"csv\",\n",[89,479,480],{"class":91,"line":171},[89,481,482],{"class":103},"    \"storage_config\": {\n",[89,484,485],{"class":91,"line":177},[89,486,487],{"class":103},"      \"provider\": \"s3\",\n",[89,489,490],{"class":91,"line":183},[89,491,492],{"class":103},"      \"uri\": \"s3:\u002F\u002Fmy-bucket\u002Fexports\u002Fcsv\u002F\",\n",[89,494,495],{"class":91,"line":189},[89,496,497],{"class":103},"      \"region\": \"us-east-1\",\n",[89,499,500],{"class":91,"line":195},[89,501,502],{"class":103},"      \"credentials_ref\": \"secret\u002Fdata\u002Faws\u002Fmy-bucket\"\n",[89,504,506],{"class":91,"line":505},14,[89,507,408],{"class":103},[89,509,511],{"class":91,"line":510},15,[89,512,198],{"class":103},[30,514,515],{},"Response includes a connection ID:",[19,517,521],{"className":518,"code":519,"language":520,"meta":28,"style":28},"language-json shiki shiki-themes github-light github-dark","{\n  \"id\": \"conn_2t3EmXcvcg2J6I9mJ02UaiMVxfb\",\n  \"name\": \"mysql-source\",\n  \"type\": \"mysql\",\n  \"created\": 1739572516\n}\n","json",[26,522,523,529,543,555,567,577],{"__ignoreMap":28},[89,524,525],{"class":91,"line":92},[89,526,528],{"class":527},"sVt8B","{\n",[89,530,531,534,537,540],{"class":91,"line":113},[89,532,533],{"class":99},"  \"id\"",[89,535,536],{"class":527},": ",[89,538,539],{"class":103},"\"conn_2t3EmXcvcg2J6I9mJ02UaiMVxfb\"",[89,541,542],{"class":527},",\n",[89,544,545,548,550,553],{"class":91,"line":124},[89,546,547],{"class":99},"  \"name\"",[89,549,536],{"class":527},[89,551,552],{"class":103},"\"mysql-source\"",[89,554,542],{"class":527},[89,556,557,560,562,565],{"class":91,"line":134},[89,558,559],{"class":99},"  \"type\"",[89,561,536],{"class":527},[89,563,564],{"class":103},"\"mysql\"",[89,566,542],{"class":527},[89,568,569,572,574],{"class":91,"line":144},[89,570,571],{"class":99},"  \"created\"",[89,573,536],{"class":527},[89,575,576],{"class":99},"1739572516\n",[89,578,579],{"class":91,"line":153},[89,580,581],{"class":527},"}\n",[14,583,585],{"id":584},"create-a-stream-configuration","Create a stream configuration",[30,587,588],{},"The stream config defines source, target, mode, and scope.",[30,590,591,592,595,596,599,600,603],{},"For single-source streams, omit the ",[26,593,594],{},"alias"," field on the connection. Aliases are only needed in multi-source streams, where each connection gets a unique alias (e.g., ",[26,597,598],{},"db1",", ",[26,601,602],{},"pg1",") used as a prefix in table references.",[77,605,607],{"id":606},"minimal-example-full-database-migration","Minimal example (full database migration)",[19,609,611],{"className":83,"code":610,"language":85,"meta":28,"style":28},"curl -X POST \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstream-configs\" \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"X-Install-ID: YOUR_INSTALL_ID\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"full_migration\",\n    \"mode\": \"load\",\n    \"source\": {\n      \"connections\": [\n        {\n          \"connectionId\": \"conn_SOURCE_ID\",\n          \"database\": \"source_db\"\n        }\n      ]\n    },\n    \"target\": {\n      \"id\": \"conn_TARGET_ID\",\n      \"spec\": {\n        \"db\": {\n          \"database\": \"target_db\"\n        }\n      }\n    }\n  }'\n",[26,612,613,626,634,642,650,656,661,666,671,676,681,686,691,696,701,706,712,718,724,730,736,741,746,751],{"__ignoreMap":28},[89,614,615,617,619,621,624],{"class":91,"line":92},[89,616,96],{"class":95},[89,618,100],{"class":99},[89,620,104],{"class":103},[89,622,623],{"class":103}," \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstream-configs\"",[89,625,110],{"class":99},[89,627,628,630,632],{"class":91,"line":113},[89,629,116],{"class":99},[89,631,119],{"class":103},[89,633,110],{"class":99},[89,635,636,638,640],{"class":91,"line":124},[89,637,116],{"class":99},[89,639,129],{"class":103},[89,641,110],{"class":99},[89,643,644,646,648],{"class":91,"line":134},[89,645,116],{"class":99},[89,647,139],{"class":103},[89,649,110],{"class":99},[89,651,652,654],{"class":91,"line":144},[89,653,147],{"class":99},[89,655,150],{"class":103},[89,657,658],{"class":91,"line":153},[89,659,660],{"class":103},"    \"name\": \"full_migration\",\n",[89,662,663],{"class":91,"line":159},[89,664,665],{"class":103},"    \"mode\": \"load\",\n",[89,667,668],{"class":91,"line":165},[89,669,670],{"class":103},"    \"source\": {\n",[89,672,673],{"class":91,"line":171},[89,674,675],{"class":103},"      \"connections\": [\n",[89,677,678],{"class":91,"line":177},[89,679,680],{"class":103},"        {\n",[89,682,683],{"class":91,"line":183},[89,684,685],{"class":103},"          \"connectionId\": \"conn_SOURCE_ID\",\n",[89,687,688],{"class":91,"line":189},[89,689,690],{"class":103},"          \"database\": \"source_db\"\n",[89,692,693],{"class":91,"line":195},[89,694,695],{"class":103},"        }\n",[89,697,698],{"class":91,"line":505},[89,699,700],{"class":103},"      ]\n",[89,702,703],{"class":91,"line":510},[89,704,705],{"class":103},"    },\n",[89,707,709],{"class":91,"line":708},16,[89,710,711],{"class":103},"    \"target\": {\n",[89,713,715],{"class":91,"line":714},17,[89,716,717],{"class":103},"      \"id\": \"conn_TARGET_ID\",\n",[89,719,721],{"class":91,"line":720},18,[89,722,723],{"class":103},"      \"spec\": {\n",[89,725,727],{"class":91,"line":726},19,[89,728,729],{"class":103},"        \"db\": {\n",[89,731,733],{"class":91,"line":732},20,[89,734,735],{"class":103},"          \"database\": \"target_db\"\n",[89,737,739],{"class":91,"line":738},21,[89,740,695],{"class":103},[89,742,744],{"class":91,"line":743},22,[89,745,403],{"class":103},[89,747,749],{"class":91,"line":748},23,[89,750,408],{"class":103},[89,752,754],{"class":91,"line":753},24,[89,755,198],{"class":103},[30,757,758],{},"Omitting tables causes auto-discovery of all user tables.",[77,760,762],{"id":761},"selective-table-migration","Selective table migration",[19,764,766],{"className":83,"code":765,"language":85,"meta":28,"style":28},"curl -X POST \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstream-configs\" \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"X-Install-ID: YOUR_INSTALL_ID\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"selective_migration\",\n    \"mode\": \"load\",\n    \"source\": {\n      \"connections\": [\n        {\n          \"connectionId\": \"conn_SOURCE_ID\",\n          \"database\": \"sakila\",\n          \"tables\": [\n            {\"name\": \"actor\"},\n            {\"name\": \"film\"},\n            {\"name\": \"customer\"}\n          ]\n        }\n      ],\n      \"options\": {\n        \"dataBundleSize\": 500\n      }\n    },\n    \"target\": {\n      \"id\": \"conn_TARGET_ID\",\n      \"spec\": {\n        \"db\": {\n          \"database\": \"target_db\",\n          \"schema\": \"public\",\n          \"structureOptions\": {\n            \"tables\": true,\n            \"indexes\": true,\n            \"foreignKeys\": true\n          }\n        }\n      }\n    },\n    \"reportingInterval\": 3\n  }'\n",[26,767,768,780,788,796,804,810,815,819,823,827,831,835,840,845,850,855,860,865,869,874,879,884,888,892,896,901,906,911,917,923,929,935,941,947,953,958,963,968,974],{"__ignoreMap":28},[89,769,770,772,774,776,778],{"class":91,"line":92},[89,771,96],{"class":95},[89,773,100],{"class":99},[89,775,104],{"class":103},[89,777,623],{"class":103},[89,779,110],{"class":99},[89,781,782,784,786],{"class":91,"line":113},[89,783,116],{"class":99},[89,785,119],{"class":103},[89,787,110],{"class":99},[89,789,790,792,794],{"class":91,"line":124},[89,791,116],{"class":99},[89,793,129],{"class":103},[89,795,110],{"class":99},[89,797,798,800,802],{"class":91,"line":134},[89,799,116],{"class":99},[89,801,139],{"class":103},[89,803,110],{"class":99},[89,805,806,808],{"class":91,"line":144},[89,807,147],{"class":99},[89,809,150],{"class":103},[89,811,812],{"class":91,"line":153},[89,813,814],{"class":103},"    \"name\": \"selective_migration\",\n",[89,816,817],{"class":91,"line":159},[89,818,665],{"class":103},[89,820,821],{"class":91,"line":165},[89,822,670],{"class":103},[89,824,825],{"class":91,"line":171},[89,826,675],{"class":103},[89,828,829],{"class":91,"line":177},[89,830,680],{"class":103},[89,832,833],{"class":91,"line":183},[89,834,685],{"class":103},[89,836,837],{"class":91,"line":189},[89,838,839],{"class":103},"          \"database\": \"sakila\",\n",[89,841,842],{"class":91,"line":195},[89,843,844],{"class":103},"          \"tables\": [\n",[89,846,847],{"class":91,"line":505},[89,848,849],{"class":103},"            {\"name\": \"actor\"},\n",[89,851,852],{"class":91,"line":510},[89,853,854],{"class":103},"            {\"name\": \"film\"},\n",[89,856,857],{"class":91,"line":708},[89,858,859],{"class":103},"            {\"name\": \"customer\"}\n",[89,861,862],{"class":91,"line":714},[89,863,864],{"class":103},"          ]\n",[89,866,867],{"class":91,"line":720},[89,868,695],{"class":103},[89,870,871],{"class":91,"line":726},[89,872,873],{"class":103},"      ],\n",[89,875,876],{"class":91,"line":732},[89,877,878],{"class":103},"      \"options\": {\n",[89,880,881],{"class":91,"line":738},[89,882,883],{"class":103},"        \"dataBundleSize\": 500\n",[89,885,886],{"class":91,"line":743},[89,887,403],{"class":103},[89,889,890],{"class":91,"line":748},[89,891,705],{"class":103},[89,893,894],{"class":91,"line":753},[89,895,711],{"class":103},[89,897,899],{"class":91,"line":898},25,[89,900,717],{"class":103},[89,902,904],{"class":91,"line":903},26,[89,905,723],{"class":103},[89,907,909],{"class":91,"line":908},27,[89,910,729],{"class":103},[89,912,914],{"class":91,"line":913},28,[89,915,916],{"class":103},"          \"database\": \"target_db\",\n",[89,918,920],{"class":91,"line":919},29,[89,921,922],{"class":103},"          \"schema\": \"public\",\n",[89,924,926],{"class":91,"line":925},30,[89,927,928],{"class":103},"          \"structureOptions\": {\n",[89,930,932],{"class":91,"line":931},31,[89,933,934],{"class":103},"            \"tables\": true,\n",[89,936,938],{"class":91,"line":937},32,[89,939,940],{"class":103},"            \"indexes\": true,\n",[89,942,944],{"class":91,"line":943},33,[89,945,946],{"class":103},"            \"foreignKeys\": true\n",[89,948,950],{"class":91,"line":949},34,[89,951,952],{"class":103},"          }\n",[89,954,956],{"class":91,"line":955},35,[89,957,695],{"class":103},[89,959,961],{"class":91,"line":960},36,[89,962,403],{"class":103},[89,964,966],{"class":91,"line":965},37,[89,967,705],{"class":103},[89,969,971],{"class":91,"line":970},38,[89,972,973],{"class":103},"    \"reportingInterval\": 3\n",[89,975,977],{"class":91,"line":976},39,[89,978,198],{"class":103},[77,980,982],{"id":981},"export-to-parquet-files","Export to Parquet files",[19,984,986],{"className":83,"code":985,"language":85,"meta":28,"style":28},"curl -X POST \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstream-configs\" \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"X-Install-ID: YOUR_INSTALL_ID\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"parquet_export\",\n    \"mode\": \"load\",\n    \"source\": {\n      \"connections\": [\n        {\n          \"connectionId\": \"conn_SOURCE_ID\",\n          \"database\": \"sakila\",\n          \"tables\": [\n            {\"name\": \"film\"},\n            {\"name\": \"actor\"}\n          ]\n        }\n      ]\n    },\n    \"target\": {\n      \"id\": \"conn_FILES_TARGET_ID\",\n      \"spec\": {\n        \"files\": {\n          \"fileFormat\": \"parquet\",\n          \"format\": {\n            \"compression\": \"zstd\"\n          }\n        }\n      }\n    }\n  }'\n",[26,987,988,1000,1008,1016,1024,1030,1035,1039,1043,1047,1051,1055,1059,1063,1067,1072,1076,1080,1084,1088,1092,1097,1101,1106,1111,1116,1121,1125,1129,1133,1137],{"__ignoreMap":28},[89,989,990,992,994,996,998],{"class":91,"line":92},[89,991,96],{"class":95},[89,993,100],{"class":99},[89,995,104],{"class":103},[89,997,623],{"class":103},[89,999,110],{"class":99},[89,1001,1002,1004,1006],{"class":91,"line":113},[89,1003,116],{"class":99},[89,1005,119],{"class":103},[89,1007,110],{"class":99},[89,1009,1010,1012,1014],{"class":91,"line":124},[89,1011,116],{"class":99},[89,1013,129],{"class":103},[89,1015,110],{"class":99},[89,1017,1018,1020,1022],{"class":91,"line":134},[89,1019,116],{"class":99},[89,1021,139],{"class":103},[89,1023,110],{"class":99},[89,1025,1026,1028],{"class":91,"line":144},[89,1027,147],{"class":99},[89,1029,150],{"class":103},[89,1031,1032],{"class":91,"line":153},[89,1033,1034],{"class":103},"    \"name\": \"parquet_export\",\n",[89,1036,1037],{"class":91,"line":159},[89,1038,665],{"class":103},[89,1040,1041],{"class":91,"line":165},[89,1042,670],{"class":103},[89,1044,1045],{"class":91,"line":171},[89,1046,675],{"class":103},[89,1048,1049],{"class":91,"line":177},[89,1050,680],{"class":103},[89,1052,1053],{"class":91,"line":183},[89,1054,685],{"class":103},[89,1056,1057],{"class":91,"line":189},[89,1058,839],{"class":103},[89,1060,1061],{"class":91,"line":195},[89,1062,844],{"class":103},[89,1064,1065],{"class":91,"line":505},[89,1066,854],{"class":103},[89,1068,1069],{"class":91,"line":510},[89,1070,1071],{"class":103},"            {\"name\": \"actor\"}\n",[89,1073,1074],{"class":91,"line":708},[89,1075,864],{"class":103},[89,1077,1078],{"class":91,"line":714},[89,1079,695],{"class":103},[89,1081,1082],{"class":91,"line":720},[89,1083,700],{"class":103},[89,1085,1086],{"class":91,"line":726},[89,1087,705],{"class":103},[89,1089,1090],{"class":91,"line":732},[89,1091,711],{"class":103},[89,1093,1094],{"class":91,"line":738},[89,1095,1096],{"class":103},"      \"id\": \"conn_FILES_TARGET_ID\",\n",[89,1098,1099],{"class":91,"line":743},[89,1100,723],{"class":103},[89,1102,1103],{"class":91,"line":748},[89,1104,1105],{"class":103},"        \"files\": {\n",[89,1107,1108],{"class":91,"line":753},[89,1109,1110],{"class":103},"          \"fileFormat\": \"parquet\",\n",[89,1112,1113],{"class":91,"line":898},[89,1114,1115],{"class":103},"          \"format\": {\n",[89,1117,1118],{"class":91,"line":903},[89,1119,1120],{"class":103},"            \"compression\": \"zstd\"\n",[89,1122,1123],{"class":91,"line":908},[89,1124,952],{"class":103},[89,1126,1127],{"class":91,"line":913},[89,1128,695],{"class":103},[89,1130,1131],{"class":91,"line":919},[89,1132,403],{"class":103},[89,1134,1135],{"class":91,"line":925},[89,1136,408],{"class":103},[89,1138,1139],{"class":91,"line":931},[89,1140,198],{"class":103},[14,1142,1144],{"id":1143},"stream-operations","Stream operations",[77,1146,1148],{"id":1147},"start-a-stream","Start a stream",[19,1150,1152],{"className":83,"code":1151,"language":85,"meta":28,"style":28},"curl -X POST \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstream-configs\u002FCONFIG_ID\u002Fstart\" \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"X-Install-ID: YOUR_INSTALL_ID\"\n",[26,1153,1154,1167,1175],{"__ignoreMap":28},[89,1155,1156,1158,1160,1162,1165],{"class":91,"line":92},[89,1157,96],{"class":95},[89,1159,100],{"class":99},[89,1161,104],{"class":103},[89,1163,1164],{"class":103}," \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstream-configs\u002FCONFIG_ID\u002Fstart\"",[89,1166,110],{"class":99},[89,1168,1169,1171,1173],{"class":91,"line":113},[89,1170,116],{"class":99},[89,1172,119],{"class":103},[89,1174,110],{"class":99},[89,1176,1177,1179],{"class":91,"line":124},[89,1178,116],{"class":99},[89,1180,1181],{"class":103}," \"X-Install-ID: YOUR_INSTALL_ID\"\n",[30,1183,1184],{},"Response:",[19,1186,1188],{"className":518,"code":1187,"language":520,"meta":28,"style":28},"{\n  \"id\": \"stream_2t3HSWnLvjeOCuuVPsuJVUhawj2\"\n}\n",[26,1189,1190,1194,1203],{"__ignoreMap":28},[89,1191,1192],{"class":91,"line":92},[89,1193,528],{"class":527},[89,1195,1196,1198,1200],{"class":91,"line":113},[89,1197,533],{"class":99},[89,1199,536],{"class":527},[89,1201,1202],{"class":103},"\"stream_2t3HSWnLvjeOCuuVPsuJVUhawj2\"\n",[89,1204,1205],{"class":91,"line":124},[89,1206,581],{"class":527},[77,1208,1210],{"id":1209},"pause-resume-stop","Pause \u002F Resume \u002F Stop",[19,1212,1214],{"className":83,"code":1213,"language":85,"meta":28,"style":28},"# Pause\ncurl -X POST \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstreams\u002FSTREAM_ID\u002Fpause\" \\\n  -H \"X-API-Key: YOUR_API_KEY\" -H \"X-Install-ID: YOUR_INSTALL_ID\"\n\n# Resume\ncurl -X POST \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstreams\u002FSTREAM_ID\u002Fresume\" \\\n  -H \"X-API-Key: YOUR_API_KEY\" -H \"X-Install-ID: YOUR_INSTALL_ID\"\n\n# Stop\ncurl -X POST \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstreams\u002FSTREAM_ID\u002Fstop\" \\\n  -H \"X-API-Key: YOUR_API_KEY\" -H \"X-Install-ID: YOUR_INSTALL_ID\"\n",[26,1215,1216,1222,1235,1246,1252,1257,1270,1280,1284,1289,1302],{"__ignoreMap":28},[89,1217,1218],{"class":91,"line":92},[89,1219,1221],{"class":1220},"sJ8bj","# Pause\n",[89,1223,1224,1226,1228,1230,1233],{"class":91,"line":113},[89,1225,96],{"class":95},[89,1227,100],{"class":99},[89,1229,104],{"class":103},[89,1231,1232],{"class":103}," \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstreams\u002FSTREAM_ID\u002Fpause\"",[89,1234,110],{"class":99},[89,1236,1237,1239,1241,1244],{"class":91,"line":124},[89,1238,116],{"class":99},[89,1240,119],{"class":103},[89,1242,1243],{"class":99}," -H",[89,1245,1181],{"class":103},[89,1247,1248],{"class":91,"line":134},[89,1249,1251],{"emptyLinePlaceholder":1250},true,"\n",[89,1253,1254],{"class":91,"line":144},[89,1255,1256],{"class":1220},"# Resume\n",[89,1258,1259,1261,1263,1265,1268],{"class":91,"line":153},[89,1260,96],{"class":95},[89,1262,100],{"class":99},[89,1264,104],{"class":103},[89,1266,1267],{"class":103}," \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstreams\u002FSTREAM_ID\u002Fresume\"",[89,1269,110],{"class":99},[89,1271,1272,1274,1276,1278],{"class":91,"line":159},[89,1273,116],{"class":99},[89,1275,119],{"class":103},[89,1277,1243],{"class":99},[89,1279,1181],{"class":103},[89,1281,1282],{"class":91,"line":165},[89,1283,1251],{"emptyLinePlaceholder":1250},[89,1285,1286],{"class":91,"line":171},[89,1287,1288],{"class":1220},"# Stop\n",[89,1290,1291,1293,1295,1297,1300],{"class":91,"line":177},[89,1292,96],{"class":95},[89,1294,100],{"class":99},[89,1296,104],{"class":103},[89,1298,1299],{"class":103}," \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstreams\u002FSTREAM_ID\u002Fstop\"",[89,1301,110],{"class":99},[89,1303,1304,1306,1308,1310],{"class":91,"line":183},[89,1305,116],{"class":99},[89,1307,119],{"class":103},[89,1309,1243],{"class":99},[89,1311,1181],{"class":103},[77,1313,1315],{"id":1314},"check-stream-status","Check stream status",[19,1317,1319],{"className":83,"code":1318,"language":85,"meta":28,"style":28},"curl \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstreams\u002FSTREAM_ID\u002Fstats\" \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"X-Install-ID: YOUR_INSTALL_ID\"\n",[26,1320,1321,1330,1338],{"__ignoreMap":28},[89,1322,1323,1325,1328],{"class":91,"line":92},[89,1324,96],{"class":95},[89,1326,1327],{"class":103}," \"http:\u002F\u002Flocalhost\u002Fapi\u002Fv1\u002Fstreams\u002FSTREAM_ID\u002Fstats\"",[89,1329,110],{"class":99},[89,1331,1332,1334,1336],{"class":91,"line":113},[89,1333,116],{"class":99},[89,1335,119],{"class":103},[89,1337,110],{"class":99},[89,1339,1340,1342],{"class":91,"line":124},[89,1341,116],{"class":99},[89,1343,1181],{"class":103},[14,1345,1347],{"id":1346},"stream-states","Stream states",[1349,1350,1351,1364],"table",{},[1352,1353,1354],"thead",{},[1355,1356,1357,1361],"tr",{},[1358,1359,1360],"th",{},"State",[1358,1362,1363],{},"Description",[1365,1366,1367,1376,1384,1392,1400,1408,1416,1424],"tbody",{},[1355,1368,1369,1373],{},[1370,1371,1372],"td",{},"READY",[1370,1374,1375],{},"Created, not yet started",[1355,1377,1378,1381],{},[1370,1379,1380],{},"RUNNING",[1370,1382,1383],{},"Active data transfer",[1355,1385,1386,1389],{},[1370,1387,1388],{},"PAUSED",[1370,1390,1391],{},"Temporarily suspended, can be resumed",[1355,1393,1394,1397],{},[1370,1395,1396],{},"STOPPED",[1370,1398,1399],{},"Terminated, cannot be resumed",[1355,1401,1402,1405],{},[1370,1403,1404],{},"FINISHED",[1370,1406,1407],{},"Completed successfully",[1355,1409,1410,1413],{},[1370,1411,1412],{},"FAILED",[1370,1414,1415],{},"Error state",[1355,1417,1418,1421],{},[1370,1419,1420],{},"TIME_LIMIT_REACHED",[1370,1422,1423],{},"Stopped after configured time limit",[1355,1425,1426,1429],{},[1370,1427,1428],{},"EVENT_LIMIT_REACHED",[1370,1430,1431],{},"Stopped after configured event limit",[14,1433,1435],{"id":1434},"error-codes","Error codes",[1349,1437,1438,1448],{},[1352,1439,1440],{},[1355,1441,1442,1445],{},[1358,1443,1444],{},"Code",[1358,1446,1447],{},"Meaning",[1365,1449,1450,1458,1466,1474,1482],{},[1355,1451,1452,1455],{},[1370,1453,1454],{},"400",[1370,1456,1457],{},"Invalid request payload",[1355,1459,1460,1463],{},[1370,1461,1462],{},"401",[1370,1464,1465],{},"Missing or invalid authentication",[1355,1467,1468,1471],{},[1370,1469,1470],{},"404",[1370,1472,1473],{},"Resource not found",[1355,1475,1476,1479],{},[1370,1477,1478],{},"409",[1370,1480,1481],{},"Conflict (e.g. starting a stream while another is paused)",[1355,1483,1484,1487],{},[1370,1485,1486],{},"500",[1370,1488,1489],{},"Server error",[14,1491,1493],{"id":1492},"next-steps","Next steps",[312,1495,1496,1501,1507],{},[315,1497,1498,1500],{},[43,1499,46],{"href":45}," — full Swagger documentation",[315,1502,1503],{},[43,1504,1506],{"href":1505},"\u002Fdocs\u002Fapi\u002Flogs-and-monitoring","Logs & Monitoring API",[315,1508,1509],{},[43,1510,1512],{"href":1511},"\u002Fdocs\u002Fstreams\u002Fstream-configuration-guide","Stream Configuration Guide",[1514,1515,1516],"style",{},"html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}",{"title":28,"searchDepth":113,"depth":113,"links":1518},[1519,1520,1521,1527,1532,1537,1538,1539],{"id":16,"depth":113,"text":17},{"id":50,"depth":113,"text":51},{"id":74,"depth":113,"text":75,"children":1522},[1523,1524,1525,1526],{"id":79,"depth":124,"text":80},{"id":207,"depth":124,"text":208},{"id":296,"depth":124,"text":297},{"id":415,"depth":124,"text":416},{"id":584,"depth":113,"text":585,"children":1528},[1529,1530,1531],{"id":606,"depth":124,"text":607},{"id":761,"depth":124,"text":762},{"id":981,"depth":124,"text":982},{"id":1143,"depth":113,"text":1144,"children":1533},[1534,1535,1536],{"id":1147,"depth":124,"text":1148},{"id":1209,"depth":124,"text":1210},{"id":1314,"depth":124,"text":1315},{"id":1346,"depth":113,"text":1347},{"id":1434,"depth":113,"text":1435},{"id":1492,"depth":113,"text":1493},"Interact with the DBConvert Streams API to manage connections and streams programmatically.","md",{},false,"\u002Fdocs\u002Fguide\u002Fapi-usage-guide",null,{"title":5,"description":1540},"docs\u002Fguide\u002Fapi-usage-guide","UVuIkvZIN03EX2YU7KaK8IZaLKHvkWP2fTvKY2rlKsM",1783896283407]