[{"data":1,"prerenderedAt":756},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fglossary":3},{"id":4,"title":5,"body":6,"description":747,"extension":748,"meta":749,"navigation":750,"path":751,"redirect":752,"seo":753,"stem":754,"__hash__":755},"docs\u002Fdocs\u002Fglossary.md","Glossary",{"type":7,"value":8,"toc":663},"minimark",[9,13,17,22,27,47,51,59,63,67,75,79,83,100,104,117,121,128,132,142,146,158,162,166,173,177,184,188,191,195,202,205,217,221,225,228,232,240,244,248,257,261,265,277,281,285,296,300,304,312,315,319,329,333,337,344,348,359,363,367,374,378,382,385,388,392,400,404,408,415,419,422,426,432,436,440,446,450,457,461,468,471,478,481,494,498,505,509,512,528,532,535,586,590,594,604,608,614,618,630,634,638,646,650,654],[10,11,5],"h1",{"id":12},"glossary",[14,15,16],"p",{},"An alphabetical list of terms used in the DBConvert Streams documentation.",[18,19,21],"h2",{"id":20},"a","A",[23,24,26],"h3",{"id":25},"alias","Alias",[14,28,29,30,34,35,39,40,39,43,46],{},"A short identifier assigned to a connection in ",[20,31,33],{"href":32},"\u002Fdocs\u002Fdatabase-explorer\u002Ffederated-queries","federated query"," mode. Aliases are auto-generated based on connection type (e.g., ",[36,37,38],"code",{},"pg1",", ",[36,41,42],{},"my1",[36,44,45],{},"aws",") and used to qualify table references across multiple sources.",[23,48,50],{"id":49},"api-key","API Key",[14,52,53,54,58],{},"A unique authentication token required to access DBConvert Streams services. See ",[20,55,57],{"href":56},"\u002Fdocs\u002Fguide\u002Flicensing","Licensing, Seats, and Telemetry",".",[18,60,62],{"id":61},"b","B",[23,64,66],{"id":65},"binary-log-binlog","Binary Log (Binlog)",[14,68,69,70,74],{},"A collection of log files generated by a MySQL server that records data modifications (INSERT, UPDATE, DELETE). DBConvert Streams reads binlog events in ",[20,71,73],{"href":72},"#cdc-mode","CDC mode"," to replicate changes to the target.",[18,76,78],{"id":77},"c","C",[23,80,82],{"id":81},"cdc-mode","CDC Mode",[14,84,85,86,90,91,95,96,58],{},"A stream mode where DBConvert Streams captures changes from database transaction logs — ",[20,87,89],{"href":88},"#binary-log-binlog","binlog"," for MySQL, ",[20,92,94],{"href":93},"#write-ahead-log-wal","WAL"," for PostgreSQL. Supports INSERT, UPDATE, and DELETE operations. See ",[20,97,99],{"href":98},"\u002Fdocs\u002Fintegration\u002Fwhat-is-cdc","What is Change Data Capture",[23,101,103],{"id":102},"change-data-capture","Change Data Capture",[14,105,106,107,110,111,114,115,58],{},"A technology that extracts row-level changes from database transaction logs. DBConvert Streams reads ",[20,108,109],{"href":88},"MySQL binlog"," and ",[20,112,113],{"href":93},"PostgreSQL WAL"," to capture data. See ",[20,116,82],{"href":72},[23,118,120],{"id":119},"connection","Connection",[14,122,123,124,58],{},"A configured link to a database, file system, or S3-compatible storage provider. Connections store host, credentials, and access settings. See ",[20,125,127],{"href":126},"\u002Fdocs\u002Fconnections\u002Fconnection-management","Connection Management",[23,129,131],{"id":130},"load-mode","Load Mode",[14,133,134,135,138,139,58],{},"A stream mode where DBConvert Streams reads data directly from source tables in bulk, without using transaction logs. Supports INSERT operations only. In API payloads, this mode is represented as ",[36,136,137],{},"\"mode\": \"load\"",". See ",[20,140,131],{"href":141},"\u002Fdocs\u002Fintegration\u002Fconversion-mode",[23,143,145],{"id":144},"csv","CSV",[14,147,148,149,153,154,157],{},"Comma-separated values file format. Supported as both a file source (via ",[20,150,152],{"href":151},"#duckdb","DuckDB"," ",[36,155,156],{},"read_csv_auto()",") and a target output format.",[18,159,161],{"id":160},"d","D",[23,163,165],{"id":164},"data-bundle-size","Data Bundle Size",[14,167,168,169,58],{},"The number of rows grouped into a single event before publishing to NATS. Default: 100 rows. Configurable per stream in the ",[20,170,172],{"href":171},"\u002Fdocs\u002Fstreams\u002Fstream-configuration-guide","stream configuration",[23,174,176],{"id":175},"data-explorer","Data Explorer",[14,178,179,180,58],{},"The built-in interface for browsing database schemas, viewing and editing data, running SQL queries, generating diagrams, and executing federated queries. See ",[20,181,183],{"href":182},"\u002Fdocs\u002Fdatabase-explorer\u002F","Data Explorer documentation",[23,185,187],{"id":186},"ddl","DDL",[14,189,190],{},"Data Definition Language — the subset of SQL statements that modify schema structure: CREATE, ALTER, DROP for databases, tables, views, and other objects.",[23,192,194],{"id":193},"desktop-app","Desktop App",[14,196,197,198,58],{},"A native application built with Wails that bundles the API server, source reader, target writer, and NATS into a single process. Available for Windows, macOS, and Linux. See ",[20,199,201],{"href":200},"\u002Fdocs\u002Fdeployment\u002Fdesktop-apps","Desktop Apps",[23,203,152],{"id":204},"duckdb",[14,206,207,208,212,213,58],{},"An embedded analytical SQL engine used by DBConvert Streams for querying local files and S3 objects, powering ",[20,209,211],{"href":210},"#federated-query","federated queries",", and providing SQL diagnostics in the ",[20,214,216],{"href":215},"#sql-console","SQL Console",[18,218,220],{"id":219},"e","E",[23,222,224],{"id":223},"event","Event",[14,226,227],{},"A unit of data representing a row-level change (INSERT, UPDATE, or DELETE) captured from a source for replication to a target.",[23,229,231],{"id":230},"event-stream","Event Stream",[14,233,234,235,239],{},"A continuous sequence of ",[20,236,238],{"href":237},"#event","events"," flowing from a source through NATS JetStream to one or more target writers.",[18,241,243],{"id":242},"f","F",[23,245,247],{"id":246},"federated-query","Federated Query",[14,249,250,251,253,254,58],{},"A SQL query that spans multiple sources — databases, local files, and S3 storage — in a single statement. Powered by ",[20,252,152],{"href":151}," with alias-qualified table references. See ",[20,255,256],{"href":32},"Federated Queries",[18,258,260],{"id":259},"h","H",[23,262,264],{"id":263},"hashicorp-vault","HashiCorp Vault",[14,266,267,268,272,273,58],{},"An optional secrets management backend for Docker deployments. Stores database passwords, SSL certificates, and API keys. The ",[20,269,271],{"href":270},"#desktop-app","desktop app"," uses a local encrypted file instead. See ",[20,274,276],{"href":275},"\u002Fdocs\u002Fnetwork-security\u002Fcredential-management","Credential Management",[18,278,280],{"id":279},"i","I",[23,282,284],{"id":283},"ingestion","Ingestion",[14,286,287,288,292,293,295],{},"The process of reading data from a source — either by direct table reads (",[20,289,291],{"href":290},"#load-mode","Load mode",") or from transaction logs (",[20,294,73],{"href":72},").",[18,297,299],{"id":298},"j","J",[23,301,303],{"id":302},"jsonl","JSONL",[14,305,306,307,153,309,58],{},"JSON Lines format — one JSON object per line. Supported as a target output format and queryable via ",[20,308,152],{"href":151},[36,310,311],{},"read_json_auto()",[18,313,280],{"id":314},"i-1",[23,316,318],{"id":317},"initial-load-cdc","Initial Load + CDC",[14,320,321,322,325,326,58],{},"A stream configuration where DBConvert Streams copies existing source rows first, then continues CDC from the matching source log position. Enabled with ",[36,323,324],{},"source.options.initialSnapshot.enabled=true"," in CDC mode. See ",[20,327,318],{"href":328},"\u002Fdocs\u002Fstreams\u002Finitial-load-and-cdc",[18,330,332],{"id":331},"l","L",[23,334,336],{"id":335},"load-progress","Load Progress",[14,338,339,340,343],{},"The durable per-table copy cursor stored in the NATS JetStream KV bucket under ",[36,341,342],{},"\u003CconfigID>.loadprogress",". Tracks the primary-key range boundary of each completed chunk so a resumable load can continue from the next incomplete chunk after a restart. Only populated while the chunked path is active.",[23,345,347],{"id":346},"logical-replication","Logical Replication",[14,349,350,351,354,355,58],{},"A PostgreSQL replication method that streams row-level changes via the ",[20,352,353],{"href":93},"Write Ahead Log"," at the logical level (PostgreSQL 12+). See ",[20,356,358],{"href":357},"\u002Fdocs\u002Fintegration\u002Fpostgres-cdc-source-configuration","PostgreSQL CDC Reader",[18,360,362],{"id":361},"m","M",[23,364,366],{"id":365},"metrics","Metrics",[14,368,369,370,58],{},"Measurements reported during stream execution: event counts, data sizes, transfer rates, and elapsed time. Visible in the ",[20,371,373],{"href":372},"\u002Fdocs\u002Foperations\u002Fobservability#live-stream-monitoring","Monitor tab",[18,375,377],{"id":376},"n","N",[23,379,381],{"id":380},"nats","NATS",[14,383,384],{},"A messaging system used by DBConvert Streams for communication between services. NATS JetStream provides persistent, ordered event delivery between source readers and target writers.",[18,386,387],{"id":14},"P",[23,389,391],{"id":390},"parquet","Parquet",[14,393,394,395,153,397,58],{},"A columnar file format optimized for analytical workloads. Supported as a target output format and queryable via ",[20,396,152],{"href":151},[36,398,399],{},"read_parquet()",[18,401,403],{"id":402},"r","R",[23,405,407],{"id":406},"reader","Reader",[14,409,410,411,58],{},"See ",[20,412,414],{"href":413},"#source-reader","Source Reader",[23,416,418],{"id":417},"reporting-intervals","Reporting Intervals",[14,420,421],{},"Configurable time intervals (in seconds) that determine how frequently progress updates are reported from source and target components during stream operation.",[23,423,425],{"id":424},"resumable-load","Resumable Load",[14,427,428,429,58],{},"A load mechanism that splits an eligible table into primary-key range chunks and persists the boundary of each completed chunk. If the stream is interrupted, the next start continues from the next incomplete chunk instead of re-reading rows that already reached the target. Routing is automatic per table — there is no public flag to enable or disable it. See ",[20,430,425],{"href":431},"\u002Fdocs\u002Fstreams\u002Fresumable-load",[18,433,435],{"id":434},"s","S",[23,437,439],{"id":438},"s3-compatible-storage","S3-Compatible Storage",[14,441,442,443,58],{},"Object storage accessible via the S3 protocol. Includes Amazon S3, DigitalOcean Spaces, MinIO, and other compatible providers. Used as both a file source and a target destination. See ",[20,444,439],{"href":445},"\u002Fdocs\u002Fconnections\u002Fs3-compatible-storage",[23,447,449],{"id":448},"snowflake","Snowflake",[14,451,452,453,58],{},"A cloud data warehouse supported as a target destination. Data is loaded via staged Parquet files. See ",[20,454,456],{"href":455},"\u002Fdocs\u002Fconnections\u002Fsnowflake","Snowflake Target",[23,458,460],{"id":459},"source","Source",[14,462,463,464,58],{},"A database, file system, or S3 storage from which DBConvert Streams reads data. Supported sources: MySQL 5.7+, PostgreSQL 12+, local files (CSV, JSON, Parquet), and ",[20,465,467],{"href":466},"#s3-compatible-storage","S3-compatible storage",[23,469,414],{"id":470},"source-reader",[14,472,473,474,477],{},"The service (",[36,475,476],{},"stream-reader",") that reads data from a source, converts it into events, and publishes them to NATS JetStream for consumption by target writers.",[23,479,216],{"id":480},"sql-console",[14,482,483,484,487,488,490,491,58],{},"The query editor inside ",[20,485,176],{"href":486},"#data-explorer",". Supports direct database queries, DuckDB-powered file queries, and ",[20,489,211],{"href":210}," with autocomplete, diagnostics, and templates. See ",[20,492,216],{"href":493},"\u002Fdocs\u002Fdatabase-explorer\u002Fsql-console",[23,495,497],{"id":496},"sse-server-sent-events","SSE (Server-Sent Events)",[14,499,500,501,504],{},"A protocol used to stream real-time logs and metrics from the API server to the browser. The endpoint ",[36,502,503],{},"\u002Flogs\u002Fstream"," delivers log events without requiring WebSocket connections.",[23,506,508],{"id":507},"stream-limits","Stream Limits",[14,510,511],{},"Optional constraints on a stream:",[513,514,515,522],"ul",{},[516,517,518,521],"li",{},[36,519,520],{},"numberOfEvents"," — maximum number of events to process",[516,523,524,527],{},[36,525,526],{},"elapsedTime"," — maximum duration in seconds",[23,529,531],{"id":530},"stream-states","Stream States",[14,533,534],{},"The operational states a stream can be in:",[513,536,537,544,550,556,562,568,574,580],{},[516,538,539,543],{},[540,541,542],"strong",{},"READY"," — initial state after creation",[516,545,546,549],{},[540,547,548],{},"RUNNING"," — active data transfer",[516,551,552,555],{},[540,553,554],{},"PAUSED"," — temporarily suspended",[516,557,558,561],{},[540,559,560],{},"STOPPED"," — terminated (cannot be resumed)",[516,563,564,567],{},[540,565,566],{},"FINISHED"," — successful completion",[516,569,570,573],{},[540,571,572],{},"FAILED"," — error state",[516,575,576,579],{},[540,577,578],{},"TIME_LIMIT_REACHED"," — stopped after reaching time limit",[516,581,582,585],{},[540,583,584],{},"EVENT_LIMIT_REACHED"," — stopped after reaching event limit",[18,587,589],{"id":588},"t","T",[23,591,593],{"id":592},"target","Target",[14,595,596,597,600,601,58],{},"A database, file system, or S3 storage to which data is replicated. Supported targets: MySQL, PostgreSQL, ",[20,598,449],{"href":599},"#snowflake",", CSV, JSONL, and ",[20,602,391],{"href":603},"#parquet",[23,605,607],{"id":606},"target-writer","Target Writer",[14,609,473,610,613],{},[36,611,612],{},"stream-writer",") that consumes events from NATS JetStream and writes them to the target destination. Multiple writers can run in parallel for horizontal scaling.",[23,615,617],{"id":616},"template","Template",[14,619,620,621,623,624,627,628,58],{},"A ready-made SQL snippet in the ",[20,622,216],{"href":215}," that adapts to the current query context — database-specific queries for direct connections, DuckDB ",[36,625,626],{},"read_*"," functions for file\u002FS3 connections, and cross-source patterns for ",[20,629,211],{"href":210},[18,631,633],{"id":632},"u","U",[23,635,637],{"id":636},"upsert","Upsert",[14,639,640,641,645],{},"An operation that inserts a row if it does not exist or updates it if it does, based on primary key matching. Used by the ",[20,642,644],{"href":643},"#target-writer","target writer"," in both Load and CDC modes.",[18,647,649],{"id":648},"w","W",[23,651,653],{"id":652},"write-ahead-log-wal","Write Ahead Log (WAL)",[14,655,656,657,659,660,58],{},"A PostgreSQL mechanism that records all changes before they are applied to the database. DBConvert Streams reads WAL entries in ",[20,658,73],{"href":72}," to capture row-level changes. See ",[20,661,347],{"href":662},"#logical-replication",{"title":664,"searchDepth":665,"depth":665,"links":666},"",2,[667,672,675,682,689,693,696,699,702,705,708,712,715,718,721,726,736,741,744],{"id":20,"depth":665,"text":21,"children":668},[669,671],{"id":25,"depth":670,"text":26},3,{"id":49,"depth":670,"text":50},{"id":61,"depth":665,"text":62,"children":673},[674],{"id":65,"depth":670,"text":66},{"id":77,"depth":665,"text":78,"children":676},[677,678,679,680,681],{"id":81,"depth":670,"text":82},{"id":102,"depth":670,"text":103},{"id":119,"depth":670,"text":120},{"id":130,"depth":670,"text":131},{"id":144,"depth":670,"text":145},{"id":160,"depth":665,"text":161,"children":683},[684,685,686,687,688],{"id":164,"depth":670,"text":165},{"id":175,"depth":670,"text":176},{"id":186,"depth":670,"text":187},{"id":193,"depth":670,"text":194},{"id":204,"depth":670,"text":152},{"id":219,"depth":665,"text":220,"children":690},[691,692],{"id":223,"depth":670,"text":224},{"id":230,"depth":670,"text":231},{"id":242,"depth":665,"text":243,"children":694},[695],{"id":246,"depth":670,"text":247},{"id":259,"depth":665,"text":260,"children":697},[698],{"id":263,"depth":670,"text":264},{"id":279,"depth":665,"text":280,"children":700},[701],{"id":283,"depth":670,"text":284},{"id":298,"depth":665,"text":299,"children":703},[704],{"id":302,"depth":670,"text":303},{"id":314,"depth":665,"text":280,"children":706},[707],{"id":317,"depth":670,"text":318},{"id":331,"depth":665,"text":332,"children":709},[710,711],{"id":335,"depth":670,"text":336},{"id":346,"depth":670,"text":347},{"id":361,"depth":665,"text":362,"children":713},[714],{"id":365,"depth":670,"text":366},{"id":376,"depth":665,"text":377,"children":716},[717],{"id":380,"depth":670,"text":381},{"id":14,"depth":665,"text":387,"children":719},[720],{"id":390,"depth":670,"text":391},{"id":402,"depth":665,"text":403,"children":722},[723,724,725],{"id":406,"depth":670,"text":407},{"id":417,"depth":670,"text":418},{"id":424,"depth":670,"text":425},{"id":434,"depth":665,"text":435,"children":727},[728,729,730,731,732,733,734,735],{"id":438,"depth":670,"text":439},{"id":448,"depth":670,"text":449},{"id":459,"depth":670,"text":460},{"id":470,"depth":670,"text":414},{"id":480,"depth":670,"text":216},{"id":496,"depth":670,"text":497},{"id":507,"depth":670,"text":508},{"id":530,"depth":670,"text":531},{"id":588,"depth":665,"text":589,"children":737},[738,739,740],{"id":592,"depth":670,"text":593},{"id":606,"depth":670,"text":607},{"id":616,"depth":670,"text":617},{"id":632,"depth":665,"text":633,"children":742},[743],{"id":636,"depth":670,"text":637},{"id":648,"depth":665,"text":649,"children":745},[746],{"id":652,"depth":670,"text":653},"Glossary of terms used in DBConvert Streams documentation.","md",{},false,"\u002Fdocs\u002Fglossary",null,{"title":5,"description":747},"docs\u002Fglossary","_TAXvtcdZiRt7VdBEvsCJov6bCxpnA4BFccEJWkaN9w",1783896284676]