Mage guides for getting started, building pipelines, and more.
This section of our documentation contains helpful guides and tutorials to getting started with Mage.We welcome contributions from our community. If you would like to contribute your own guides or content, we encourage that as well! It’s written entirely in Markdown and very user friendly.At the bottom of every doc, there’s a link to edit the page on GitHub. Click that link and you’ll be taken to the Markdown file for that page. You can edit the file directly in your browser and submit a pull request.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Mage AI","colors":{"primary":"#6A35FF","light":"#00FB82","dark":"#148EFF"},"logo":{"light":"https://mintcdn.com/mage/Rq76a-vYmKWfFOND/logo/m-mage-light.svg?fit=max\u0026auto=format\u0026n=Rq76a-vYmKWfFOND\u0026q=85\u0026s=090f9ad5ae13615190d3522f6cb49ee2","dark":"https://mintcdn.com/mage/Rq76a-vYmKWfFOND/logo/m-mage.svg?fit=max\u0026auto=format\u0026n=Rq76a-vYmKWfFOND\u0026q=85\u0026s=f9f81bdba38ed26df9c59cf5c06b1b91"},"favicon":"https://mintcdn.com/mage/Rq76a-vYmKWfFOND/favicons/m1.svg?fit=max\u0026auto=format\u0026n=Rq76a-vYmKWfFOND\u0026q=85\u0026s=02b66df48d663d0e5a667850de44fe45","api":{"playground":{"display":"none"}},"appearance":{"default":"dark","strict":false},"background":{"image":"https://mintcdn.com/mage/KCVtYQD46PIylqWZ/background.png?fit=max\u0026auto=format\u0026n=KCVtYQD46PIylqWZ\u0026q=85\u0026s=8ce1090758f30e407a66ae048dd5d19c","decoration":"gradient","color":{"light":"#FFFFFF","dark":"#000000"}},"navbar":{"links":[{"href":"https://github.com/mage-ai/mage-ai","label":"GitHub"},{"href":"https://www.mage.ai/chat","label":"Community"},{"href":"https://cloud.mage.ai/sign-up?source=documentation-header","label":"Mage Pro"}],"primary":{"type":"button","label":"Get a demo","href":"https://mage.ai/getdemo"}},"footer":{"socials":{"github":"https://www.github.com/mage-ai","slack":"https://www.mage.ai/chat","linkedin":"https://www.linkedin.com/company/magetech","twitter":"https://twitter.com/mage_ai"},"links":[{"header":"OSS","items":[{"label":"Code","href":"https://www.mage.ai.oss"},{"label":"Demo playground","href":"https://www.mage.ai/demo"}]},{"header":"Mage Pro","items":[{"label":"Get started for free","href":"https://cloud.mage.ai/sign-up"}]},{"header":"Community","items":[{"label":"Chat","href":"https://www.mage.ai/chat"},{"label":"Facebook","href":"https://www.facebook.com/mageai"},{"label":"Youtube","href":"https://www.youtube.com/@mage_ai"},{"label":"Instagram","href":"https://www.instagram.com/mage_ai"},{"label":"Medium","href":"https://m.mage.ai"}]}]},"search":{"prompt":"Omniscience... ✨"},"seo":{"metatags":{"og:image":"https://github.com/mage-ai/mage-ai/blob/master/docs/og.png?raw=True","og:description":"The leading framework for transforming and integrating data.","og:site_name":"Mage AI Documentation","twitter:site":"@mage_ai"},"indexing":"all"},"fonts":{"heading":{"family":"Alkatra"},"body":{"family":"Inter"}},"styling":{"codeblocks":"system","latex":false},"integrations":{"koala":{"publicApiKey":"pk_a3151d9755887a36858dcd602fbaeb5ee2f7"},"ga4":{"measurementId":"G-GR172GGB5V"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mage","hasAudioNarration":false,"actualSubdomain":"mage","customDomains":["docs.mage.ai"],"gitSource":{"type":"github","owner":"mage-ai","repo":"mage-ai","deployBranch":"master","contentDirectory":"docs","mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af6eba0ea2e3b727f3c5019","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Documentation","count":146},{"language":"default","tag":"Concepts","count":103},{"language":"default","tag":"Data integrations","count":90},{"language":"default","tag":"Development","count":83},{"language":"default","tag":"Mage Pro","count":76},{"language":"default","tag":"Sources","count":72},{"language":"default","tag":"Pipelines","count":50},{"language":"default","tag":"Production","count":48},{"language":"default","tag":"Destinations","count":47},{"language":"default","tag":"Streaming","count":42}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#topbar-cta-button{}#navbar{}#sidebar{}#content-area{}#table-of-contents{}footer{}a.block{display:block}p.normal,span.normal{font-weight:normal!important}"}],"page":{"pagePath":"guides/overview","slug":"/guides/overview","pageMetadata":{"title":"Mage Guides","icon":"fly","sidebarTitle":"Guides","description":"Mage guides for getting started, building pipelines, and more.","href":"/guides/overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Mage guides for getting started, building pipelines, and more.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={em:`em`,p:`p`,..._provideComponents(),...props.components},{OptimizedImage}=_components;if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);return _jsxs(_Fragment,{children:[_jsx(`p`,{align:`center`,children:_jsx(OptimizedImage,{src:`https://github.com/mage-ai/mage-ai/assets/59450879/7ef1cc84-0b15-4e6c-aa5c-74fdba7c2d5f`})}),`\n`,_jsx(_components.p,{children:`This section of our documentation contains helpful guides and tutorials to getting started with Mage.`}),`\n`,_jsxs(_components.p,{children:[`We welcome contributions from our community. If you would like to contribute your own guides or content, we encourage that as well! It’s written entirely in Markdown and `,_jsx(_components.em,{children:`very`}),` user friendly.`]}),`\n`,_jsx(_components.p,{children:`At the bottom of every doc, there’s a link to edit the page on GitHub. Click that link and you’ll be taken to the Markdown file for that page. You can edit the file directly in your browser and submit a pull request.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Mage Guides","icon":"fly","sidebarTitle":"Guides","description":"Mage guides for getting started, building pipelines, and more.","href":"/guides/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"mage","siteName":"Mage AI","title":"Mage Guides - Mage AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-22T22:56:37.394Z","originalFileLocation":"guides/overview.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Mage guides for getting started, building pipelines, and more.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Mage AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mage/7GSCLO7OarQPQehu/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/mage/7GSCLO7OarQPQehu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mage/7GSCLO7OarQPQehu/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mage/7GSCLO7OarQPQehu/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mage/7GSCLO7OarQPQehu/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mage/7GSCLO7OarQPQehu/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mage/7GSCLO7OarQPQehu/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mage/7GSCLO7OarQPQehu/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mage/7GSCLO7OarQPQehu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Mage Guides - Mage AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"The leading framework for transforming and integrating data.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Mage AI Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.mage.ai/guides/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://github.com/mage-ai/mage-ai/blob/master/docs/og.png?raw=True\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Mage Guides - Mage AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The leading framework for transforming and integrating data.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://github.com/mage-ai/mage-ai/blob/master/docs/og.png?raw=True\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/mage/7GSCLO7OarQPQehu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Mage AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6A35FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.mage.ai/guides/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/guides/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.mage.ai/#organization\",\"name\":\"Mage AI\",\"url\":\"https://docs.mage.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mage/Rq76a-vYmKWfFOND/logo/m-mage-light.svg?fit=max\u0026auto=format\u0026n=Rq76a-vYmKWfFOND\u0026q=85\u0026s=090f9ad5ae13615190d3522f6cb49ee2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.mage.ai#website\",\"name\":\"Mage AI\",\"url\":\"https://docs.mage.ai\",\"publisher\":{\"@id\":\"https://docs.mage.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.mage.ai/guides/overview#webpage\",\"url\":\"https://docs.mage.ai/guides/overview\",\"name\":\"Mage Guides\",\"description\":\"Mage guides for getting started, building pipelines, and more.\",\"dateModified\":\"2026-01-22T22:56:37.394Z\",\"isPartOf\":{\"@id\":\"https://docs.mage.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.mage.ai/guides/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.mage.ai/guides/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Mage AI\",\"item\":\"https://docs.mage.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Mage Guides\",\"item\":\"https://docs.mage.ai/guides/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.mage.ai/guides/overview#article\",\"headline\":\"Mage Guides\",\"name\":\"Mage Guides\",\"description\":\"Mage guides for getting started, building pipelines, and more.\",\"url\":\"https://docs.mage.ai/guides/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.mage.ai/guides/overview#webpage\"},\"image\":\"https://github.com/mage-ai/mage-ai/blob/master/docs/og.png?raw=True\",\"dateModified\":\"2026-01-22T22:56:37.394Z\",\"publisher\":{\"@id\":\"https://docs.mage.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.mage.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Mage AI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Mage AI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/guides/overview.md","siteName":"Mage AI","nav":{"global":null,"tabs":[{"tab":"Mage Pro","pages":[{"title":"Mage Pro","href":"/production/mage/pro"}]},{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction/overview"}]},{"tab":"Development","groups":[{"group":"Quickstart","pages":[{"title":"Mage Guides","icon":"fly","sidebarTitle":"Guides","href":"/guides/overview"},{"title":"Mage tips \u0026 tricks","sidebarTitle":"Tips \u0026 tricks","icon":"question","description":"Here are some neat ways you can make the most of Mage! Tips and tricks to help you make the most magical pipelines possible.","href":"/guides/tips-and-tricks"},{"title":"Troubleshooting","icon":"question","href":"/development/troubleshooting"}]},{"group":"Developer experience","pages":[{"title":"Writing data pipeline code","sidebarTitle":"Code editor","icon":"code","href":"/guides/developer-ux/code-editor"},{"title":"Block dependency tree","sidebarTitle":"Dependency tree","icon":"tree","href":"/guides/developer-ux/block-dependency-tree"},{"title":"Browse all files","sidebarTitle":"File browser","icon":"files","href":"/guides/developer-ux/file-browser"},{"title":"Pipeline sidekick","sidebarTitle":"Sidekick","icon":"mask","href":"/guides/developer-ux/sidekick"}]},{"group":"Version control","pages":[{"title":"Configure Git","sidebarTitle":"Configurations","icon":"code-pull-request-draft","href":"/guides/git/configure"},{"title":"Version control application with Git","sidebarTitle":"Git application","icon":"code-branch","href":"/guides/data-sync/version-control"},{"title":"One-way code sync using Git","sidebarTitle":"Git sync","icon":"code-merge","href":"/guides/data-sync/git-sync"},{"title":"Git integration for code version control","sidebarTitle":"Git integration","icon":"code-fork","href":"/guides/data-sync/git-integration"}]},{"group":"Blocks","icon":"block-brick","pages":[{"title":"Reordering blocks","sidebarTitle":"Reorder","icon":"arrows-up-down-left-right","href":"/guides/blocks/reorder-blocks"},{"title":"Reuse blocks","sidebarTitle":"Reuse blocks","icon":"share","href":"/guides/blocks/reuse-blocks"},{"title":"User-defined templates","sidebarTitle":"User-defined templates","icon":"book","href":"/guides/blocks/user-defined-templates"},{"title":"Detaching blocks","sidebarTitle":"Detach","icon":"link-slash","href":"/guides/blocks/detach-blocks"},{"title":"Dynamic blocks","sidebarTitle":"Dynamic","icon":"list-tree","href":"/guides/blocks/dynamic-blocks"},{"title":"Native support for Polars","sidebarTitle":"Polars","icon":"teddy-bear","href":"/guides/blocks/polars"},{"title":"Replicating blocks","sidebarTitle":"Replicate","icon":"copy","href":"/guides/blocks/replicate-blocks"},{"title":"Transformer blocks","sidebarTitle":"Transformers","icon":"transporter-3","href":"/guides/blocks/transformer-blocks"},{"title":"Custom blocks","sidebarTitle":"Custom","icon":"block-quote","href":"/guides/blocks/custom-blocks"},{"title":"Markdown blocks","sidebarTitle":"Markdown","icon":"markdown","href":"/guides/blocks/markdown-blocks"},{"title":"SQL blocks","sidebarTitle":"SQL","icon":"database","href":"/guides/blocks/sql-blocks"},{"title":"R blocks","sidebarTitle":"R","icon":"flask","href":"/guides/blocks/r-blocks"}]},{"group":"Pipelines","icon":"pipe-section","pages":[{"title":"ETL pipeline tutorial","sidebarTitle":"Batch","icon":"truck-ramp-box","href":"/guides/load-api-data"},{"title":"How to build a data integration pipeline","sidebarTitle":"Data integration","icon":"pipe-circle-check","href":"/guides/data-integration-pipeline"},{"group":"Streaming","icon":"water","pages":[{"title":"Overview","href":"/guides/streaming/introduction"},{"group":"Sources","pages":[{"title":"ActiveMQ","href":"/guides/streaming/sources/activemq"},{"title":"Amazon SQS","href":"/guides/streaming/sources/amazon-sqs"},{"title":"Azure Event Hub","href":"/guides/streaming/sources/azure-event-hub"},{"title":"Google Cloud PubSub","href":"/guides/streaming/sources/google-cloud-pubsub"},{"title":"InfluxDB","href":"/guides/streaming/sources/influxdb"},{"title":"Kafka","href":"/guides/streaming/sources/kafka"},{"title":"Kinesis","href":"/guides/streaming/sources/kinesis"},{"title":"NATS.io - JetStream","href":"/guides/streaming/sources/nats"},{"title":"OracleDB","href":"/guides/streaming/sources/oracledb"},{"title":"PostgreSQL CDC","href":"/guides/streaming/sources/postgres-cdc"},{"title":"RabbitMQ","href":"/guides/streaming/sources/rabbitmq"},{"title":"MongoDB","href":"/guides/streaming/sources/mongodb"},{"title":"MySQL CDC","href":"/guides/streaming/sources/mysql-cdc"},{"title":"Microsoft SQL Server CDC","href":"/guides/streaming/sources/mssql-cdc"}]},{"group":"Destinations","pages":[{"title":"ActiveMQ","href":"/guides/streaming/destinations/activemq"},{"title":"Amazon S3","href":"/guides/streaming/destinations/amazon-s3"},{"title":"BigQuery","href":"/guides/streaming/destinations/bigquery"},{"title":"ClickHouse","href":"/guides/streaming/destinations/clickhouse"},{"title":"DuckDB","href":"/guides/streaming/destinations/duckdb"},{"title":"Dummy","href":"/guides/streaming/destinations/dummy"},{"title":"Elasticsearch","href":"/guides/streaming/destinations/elasticsearch"},{"title":"Google Cloud PubSub","href":"/guides/streaming/destinations/google-cloud-pubsub"},{"title":"Google Cloud Storage","href":"/guides/streaming/destinations/google-cloud-storage"},{"title":"InfluxDB","href":"/guides/streaming/destinations/influxdb"},{"title":"Kafka","href":"/guides/streaming/destinations/kafka"},{"title":"Kinesis","href":"/guides/streaming/destinations/kinesis"},{"title":"MongoDB","href":"/guides/streaming/destinations/mongodb"},{"title":"Microsoft SQL Server","href":"/guides/streaming/destinations/mssql"},{"title":"MySQL","href":"/guides/streaming/destinations/mysql"},{"title":"Opensearch","href":"/guides/streaming/destinations/opensearch"},{"title":"Oracle Database","href":"/guides/streaming/destinations/oracledb"},{"title":"Postgres","href":"/guides/streaming/destinations/postgres"},{"title":"RabbitMQ","href":"/guides/streaming/destinations/rabbitmq"},{"title":"Redshift","href":"/guides/streaming/destinations/redshift"},{"title":"Snowflake","href":"/guides/streaming/destinations/snowflake"},{"title":"Trino","href":"/guides/streaming/destinations/trino"}]},{"group":"Tutorials","pages":[{"title":"Kafka streaming pipeline","href":"/guides/streaming/tutorials/streaming-pipeline"},{"title":"🎏 Local stream to dbt transform","sidebarTitle":"Streaming + dbt transform","href":"/guides/streaming/tutorials/magic-devcontainer"},{"title":"RabbitMQ streaming pipeline","href":"/guides/streaming/tutorials/streaming-pipeline-rabbitmq"}]}]},{"title":"Importing pipelines","sidebarTitle":"Importing","icon":"cloud-arrow-up","href":"/guides/pipelines/importing-pipelines"},{"title":"Community Examples","icon":"people","href":"/guides/community-examples"}]},{"group":"dbt","icon":"arrow-progress","pages":[{"title":"Use dbt with Mage: Simplify Your Data Transformation Pipelines","sidebarTitle":"Overview","icon":"wind-turbine","href":"/guides/dbt/overview"},{"title":"Develop dbt in Mage","sidebarTitle":"Getting started","icon":"sliders","href":"/guides/dbt/developing-dbt-in-mage"},{"title":"Make dbt magical","sidebarTitle":"New project","icon":"arrows-spin","href":"/guides/dbt/setup-dbt"},{"group":"Configuration","icon":"screwdriver-wrench","pages":[{"title":"dbt sources and upstream dependencies","sidebarTitle":"Get data from blocks","href":"/guides/dbt/sources"},{"title":"dbt connection profiles","sidebarTitle":"Connection profiles","href":"/guides/dbt/connection-profiles"},{"title":"dbt variable interpolation","sidebarTitle":"Variable interpolation","href":"/guides/dbt/variable-interpolation"},{"title":"Run dbt-spark against a pySpark session.","sidebarTitle":"Run dbt-spark","href":"/guides/dbt/run-dbt-spark"}]},{"group":"Models","icon":"square-m","pages":[{"title":"Add an existing dbt project to Mage","sidebarTitle":"Add existing project","href":"/guides/dbt/add-existing-dbt"},{"title":"Incremental models","href":"/guides/dbt/incremental-models"},{"title":"Run a single model","sidebarTitle":"Run a model","href":"/guides/dbt/run-single-model"},{"title":"Run multiple models","sidebarTitle":"Run multiple models","href":"/guides/dbt/run-selected-model"}]},{"group":"Commands","icon":"command","pages":[{"title":"Serve dbt docs in production","sidebarTitle":"Docs","href":"/guides/dbt/docs"},{"title":"Run dbt snapshot","sidebarTitle":"Snapshots","href":"/guides/dbt/snapshots"},{"title":"Running dbt tests","sidebarTitle":"Tests","href":"/guides/dbt/running-dbt-tests"}]}]}]},{"tab":"Production","pages":[{"title":"Production","href":"/production/ci-cd/overview"}]},{"tab":"AI","pages":[{"title":"AI","href":"/ai/sidekick"}]},{"tab":"Observability","pages":[{"title":"Observability","href":"/observability/monitoring"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/compute/spark-pyspark"}]},{"tab":"Extensibility","pages":[{"title":"Extensibility","href":"/extensibility/env-config/project"}]}]},"basePath":"","title":"Mage Guides - Mage AI","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-BbK2OBGL.js","lightbox-handle-r17bVUz3.js"]}