cli-reference.html



<!DOCTYPE html>

<html lang="en-US">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=Edge">

  <link rel="stylesheet" href="/assets/css/just-the-docs-default.css">
  
  <style type="text/css">
.site-nav > .nav-list:nth-child(1):not(.nav-category-list) > .nav-list-item:not(.external):nth-child(3) > .nav-list-link { display: block; font-weight: 600; text-decoration: none; background-image: linear-gradient(-90deg, #ebedf5 0%, rgba(235, 237, 245, 0.8) 80%, rgba(235, 237, 245, 0) 100%); }

.site-nav > .nav-list:nth-child(1):not(.nav-category-list) > .nav-list-item:not(.passive):nth-child(3) > .nav-list-expander svg { transform: rotate(-90deg); }
.site-nav > .nav-list:nth-child(1):not(.nav-category-list) > .nav-list-item:not(.passive):nth-child(3) > .nav-list { display: block; }

.site-nav > .nav-category-list > .nav-list-item:not(.passive) > .nav-list-expander svg { transform: rotate(-90deg); }
.site-nav > .nav-category-list > .nav-list-item:not(.passive) > .nav-list { display: block; }

</style>


    <script src="/assets/js/vendor/lunr.min.js"></script>
  

  <script src="/assets/js/just-the-docs.js"></script>

  <meta name="viewport" content="width=device-width, initial-scale=1">

  
  <link rel="icon" href="/favicon.ico" type="image/x-icon">


  <!-- Begin Jekyll SEO tag v2.8.0 -->
<title>CLI Reference | Docs</title>
<meta name="generator" content="Jekyll v3.9.3" />
<meta property="og:title" content="CLI Reference" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="lakefs-databricks CLI Reference" />
<meta property="og:description" content="lakefs-databricks CLI Reference" />
<meta property="og:site_name" content="Docs" />
<meta property="og:image" content="https://docs-databricks.lakefs.io/assets/img/docs_logo.png" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:image" content="https://docs-databricks.lakefs.io/assets/img/docs_logo.png" />
<meta property="twitter:title" content="CLI Reference" />
<meta name="twitter:site" content="@lakeFS" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"lakefs-databricks CLI Reference","headline":"CLI Reference","image":"https://docs-databricks.lakefs.io/assets/img/docs_logo.png","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/assets/lakeFS_for_databricks_logo.svg"}},"url":"/cli-reference.html"}</script>
<!-- End Jekyll SEO tag -->


  <!-- Google Tag Manager Head -->
<!-- type="text/plain" is intentional for cookie consent support -->
<script type="text/plain" data-category="analytics">(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
            new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
        j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
        'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
    })(window,document,'script','dataLayer','GTM-KTZBZW9');</script>
<!-- End Google Tag Manager Head -->

<meta property="og:image" content="/assets/img/lakefs-logo-with-text.png">
<link rel="preload" href="/assets/fonts/Rene Bieder - Galano Grotesque.otf" as="font" type="font/otf" crossorigin>
<link rel="preload" href="/assets/fonts/Rene Bieder - Galano Grotesque Medium.otf" as="font" type="font/otf" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.1/css/fontawesome.min.css" integrity="sha512-giQeaPns4lQTBMRpOOHsYnGw1tGVzbAIHUyHRgn7+6FmiEgGGjaG0T2LZJmAPMzRCl+Cug0ItQ2xDZpTmEc+CQ==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.1/css/all.min.css" integrity="sha512-MV7K8+y+gLIBoVD59lQIYicR65iaqukzvf/nwasF0nqhPay5w/9lJmVM2hMDcnK1OnMGCdVK+iQrJ7lzPJQd1w==" crossorigin="anonymous" referrerpolicy="no-referrer" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/orestbida/cookieconsent@v3.0.0/dist/cookieconsent.css">
<link rel="stylesheet" href="/assets/css/cookieconsent.css" />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js" crossorigin="anonymous"></script>
<link rel="stylesheet" href="https://ajax.googleapis.com/ajax/libs/jqueryui/1.13.2/themes/smoothness/jquery-ui.css">
<script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.13.2/jquery-ui.min.js"></script>
<script type="module" src="/assets/js/cookieconsent-init.js"></script>
<script src="/assets/js/copy-code.js"></script>
<script>
    $(function () {
        $(".tabs").tabs();
    });
</script>
<script src="/assets/js/feedback.js"></script>
<link href="https://data-folks.masto.host/@lakeFS" rel="me">

</head>

<script src="https://unpkg.com/mermaid@9.3.0/dist/mermaid.min.js"></script>
<script>
    $(document).ready(function () {
        mermaid.initialize({
            startOnLoad:true,
            theme: "default",
        });
        window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
    });
</script>
<body>
<img src="/assets/img/cookies.png" style="display: none;">
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KTZBZW9"
                  height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
    <symbol id="svg-link" viewBox="0 0 24 24">
        <title>Link</title>
        <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
             stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
             class="feather feather-link">
            <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path>
            <path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
        </svg>
    </symbol>
    <symbol id="svg-search" viewBox="0 0 24 24">
        <title>Search</title>
        <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
             stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
             class="feather feather-search">
            <circle cx="11" cy="11" r="8"></circle>
            <line x1="21" y1="21" x2="16.65" y2="16.65"></line>
        </svg>
    </symbol>
    <symbol id="svg-menu" viewBox="0 0 24 24">
        <title>Menu</title>
        <svg xmlns="http://www.w3.org/2000/svg" width="20px" height="16px" viewBox="0 0 20 16" version="1.1"
             class="feather feather-menu">
            <g id="Symbols" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
                <g id="header-/-mobile" transform="translate(-30.000000, -32.000000)" fill="#279890">
                    <g id="Group" transform="translate(30.000000, 32.000000)">
                        <path
                                d="M20,14 L20,16 L0,16 L0,14 L20,14 Z M20,7 L20,9 L0,9 L0,7 L20,7 Z M20,0 L20,2 L0,2 L0,0 L20,0 Z"
                                id="mobile-menu" />
                    </g>
                </g>
            </g>
        </svg>
    </symbol>
    <symbol id="svg-arrow-right" viewBox="0 0 24 24">
        <title>Expand</title>
        <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
             stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
             class="feather feather-chevron-right">
            <polyline points="9 18 15 12 9 6"></polyline>
        </svg>
    </symbol>
    <symbol id="svg-doc" viewBox="0 0 24 24">
        <title>Document</title>
        <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
             stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
             class="feather feather-file">
            <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path>
            <polyline points="13 2 13 9 20 9"></polyline>
        </svg>
    </symbol>
</svg>
<div class="body-wrapper">
    <div class="side-bar">
        <div class="site-header">
            <a href="https://docs-databricks.lakefs.io" class="site-title lh-tight">
  <div class="site-logo" role="img" aria-label="Docs"></div>

</a>
            <a href="#" id="menu-button" class="site-button">
                <svg viewBox="0 0 24 24" class="icon">
                    <use xlink:href="#svg-menu"></use>
                </svg>
            </a>
        </div>
        <nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
            
            <div class="search">
                <div class="search-input-wrap">
                    <input type="text" id="search-input" class="search-input" tabindex="0"
                           placeholder="Search Docs" aria-label="Search Docs"
                           autocomplete="off">
                    <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon">
                            <use xlink:href="#svg-search"></use>
                        </svg></label>
                </div>
                <div id="search-results" class="search-results"></div>
            </div>
            

            <div class="nav-category nav-version">
                <label for="selectversion">Version:</label>
                <select id="selectversion" name="version" onchange="javascript:location.href = '/' + encodeURI(this.value);">
                    <option value="" selected>Latest</option>
                </select>
            </div>
            <script async>
                window.addEventListener("load",  async () => {
                    const pathFirstLevel = location.pathname.split('/')[1];
                    const selectedVersion = pathFirstLevel.startsWith('v') && pathFirstLevel || '';
                    const selectVersionElmFirst = document.getElementById('selectversion').firstElementChild;
                    const response = await fetch('/versions.json');
                    if (!response.ok) {
                        return
                    }
                    const versions = await response.json();
                    for (let [key, value] of Object.entries(versions)) {
                        const el = document.createElement("option");
                        el.value = key;
                        el.textContent = value;
                        if (key === selectedVersion) {
                            el.selected = true;
                        }
                        selectVersionElmFirst.after(el);
                    }
                });
            </script>

            <ul class="nav-list"><li
            class="nav-list-item"><a href="/"
           class="nav-list-link">lakeFS for Databricks</a></li><li
            class="nav-list-item"><a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24">
                <use xlink:href="#svg-arrow-right"></use>
            </svg></a><a href="/getstarted/"
           class="nav-list-link">Get Started</a><ul class="nav-list "><li class="nav-list-item "><a href="/getstarted/install.html"
                   class="nav-list-link">Install</a></li><li class="nav-list-item "><a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24">
                        <use xlink:href="#svg-arrow-right"></use>
                    </svg></a><a href="/getstarted/setup/"
                   class="nav-list-link">Setup</a><ul class="nav-list"><li class="nav-list-item ">
                        <a href="/getstarted/setup/aws.html"
                           class="nav-list-link">AWS</a>
                    </li><li class="nav-list-item ">
                        <a href="/getstarted/setup/azure.html"
                           class="nav-list-link">Azure</a>
                    </li></ul></li><li class="nav-list-item "><a href="/getstarted/try-it-out.html"
                   class="nav-list-link">Try it Out</a></li></ul></li><li
            class="nav-list-item active"><a href="/cli-reference.html"
           class="nav-list-link active">CLI Reference</a></li><li
            class="nav-list-item"><a href="/limitations.html"
           class="nav-list-link">Limitations</a></li></ul>
            <div class="mobile-menu">
                
<nav aria-label="Auxiliary" class="aux-nav">
    <ul class="aux-nav-list">
        
        
        <li class="aux-nav-list-item">
            <a href="https://docs-databricks.lakefs.io/" class="site-button" >
                Docs
            </a>
        </li>
        
        <li class="aux-nav-list-item">
            <a href="https://docs-databricks.lakefs.io/blog/" class="site-button" >
                Blog
            </a>
        </li>
        
        <li class="aux-nav-list-item">
            <a href="https://docs-databricks.lakefs.io/community/" class="site-button" >
                Community
            </a>
        </li>
        
        
        <li class="aux-nav-list-item button">
            <a href="https://lakefs.io/slack" class="site-button" >
                Join us on Slack
            </a>
        </li>
        
        
    </ul>
</nav>

            </div>
        </nav>

    </div>
    <div class="main" id="top">
         <div class="feedback-container">
            <div id="is-helpful-ty">
                <div class="text-epsilon">Thank you for your feedback.</div>
                <div class="mt-2 text-epsilon">
                    <a href="https://lakefs.io/slack" target="_blank">Join the community</a> to get more help.
                </div>
            </div>
            <div class="feedback-buttons">
                <span class="tooltip">
                    <button class="page-helpful-btn far fa-lg fa-thumbs-up" id="page-helpful-yes"></button>
                    <span class="tooltiptext">
                        This page is <b>helpful</b>
                    </span>
                </span>
                <span class="tooltip">
                    <button class="page-helpful-btn far fa-lg fa-thumbs-down" id="page-helpful-no"></button>
                    <span class="tooltiptext">
                        This page is <b>not helpful</b>
                    </span>
                </span>
            </div>
        </div>
        <div id="main-header" class="main-header">
            
<nav aria-label="Auxiliary" class="aux-nav">
    <ul class="aux-nav-list">
        
        
        <li class="aux-nav-list-item">
            <a href="https://docs-databricks.lakefs.io/" class="site-button" >
                Docs
            </a>
        </li>
        
        <li class="aux-nav-list-item">
            <a href="https://docs-databricks.lakefs.io/blog/" class="site-button" >
                Blog
            </a>
        </li>
        
        <li class="aux-nav-list-item">
            <a href="https://docs-databricks.lakefs.io/community/" class="site-button" >
                Community
            </a>
        </li>
        
        
        <li class="aux-nav-list-item button">
            <a href="https://lakefs.io/slack" class="site-button" >
                Join us on Slack
            </a>
        </li>
        
        
    </ul>
</nav>

        </div>
        <div id="main-content-wrap" class="main-content-wrap">
            
            
            <div id="main-content" class="main-content" role="main">
                
                    <h1 id="lakefs-databricks-cli-reference">
  
  
    <a href="#lakefs-databricks-cli-reference" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> lakefs-databricks CLI Reference
  
  
</h1>
    

<div class="toc-block">
<h2 class="no_toc text-delta" id="table-of-contents">
  
  
    <a href="#table-of-contents" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Table of contents
  
  
</h2>
    

<ol id="markdown-toc">
  <li><a href="#cli-configuration" id="markdown-toc-cli-configuration">CLI Configuration</a></li>
  <li><a href="#command-reference" id="markdown-toc-command-reference">Command Reference</a></li>
</ol>

</div>
<h2 id="cli-configuration">
  
  
    <a href="#cli-configuration" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> CLI Configuration
  
  
</h2>
    

<p><code class="language-plaintext highlighter-rouge">lakefs-databricks</code> can be configured using either a YAML file or environment variables.</p>
<h4 id="configuration-file">
  
  
    <a href="#configuration-file" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Configuration file
  
  
</h4>
    

<p>By default, <code class="language-plaintext highlighter-rouge">lakefs-databricks</code> will look for a file named <code class="language-plaintext highlighter-rouge">.lakefs-databricks.yaml</code> in your home directory, but the
configuration file can be specified by passing the <code class="language-plaintext highlighter-rouge">-c</code> (or <code class="language-plaintext highlighter-rouge">--config</code>) argument to <code class="language-plaintext highlighter-rouge">lakefs-databricks</code> (see below).</p>

<div class="tabs">
  <ul>
    <li><a href="#aws_file">AWS</a></li>
	<li><a href="#azure_file">Azure</a></li>
  </ul>
  <div id="aws_file">

    <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">unity</span><span class="pi">:</span>
  <span class="na">url</span><span class="pi">:</span> <span class="s">&lt;unity_url&gt;</span> <span class="c1"># Your Databricks workspace URL. e.g. https://dbc-&lt;workspace-id&gt;.cloud.databricks.com</span>
  <span class="na">token</span><span class="pi">:</span> <span class="s">&lt;unity_token&gt;</span>  <span class="c1"># The Personal access token you created during the Databricks Workspace preparation</span>
<span class="na">lakefs</span><span class="pi">:</span>
  <span class="na">secret_access_key</span><span class="pi">:</span> <span class="s">&lt;lakefs_secret_access_key&gt;</span> <span class="c1"># The secret_access_key you created during lakeFS Cloud setup</span>
  <span class="na">access_key_id</span><span class="pi">:</span> <span class="s">&lt;lakefs_access_key_id&gt;</span> <span class="c1"># The access_key_id you created during lakeFS Cloud setup</span>
  <span class="na">url</span><span class="pi">:</span> <span class="s">&lt;lakefs_endpoint_url&gt;/api/v1</span> <span class="c1"># The Url of your lakeFS Cloud instance e.g. https://example-org.us-east-1.lakefscloud.io </span>
<span class="na">databricks_storage</span><span class="pi">:</span>
  <span class="na">type</span><span class="pi">:</span> <span class="s">s3</span>
  <span class="na">s3</span><span class="pi">:</span>
    <span class="na">access_key_id</span><span class="pi">:</span> <span class="s">&lt;aws_access_key_id&gt;</span> <span class="c1"># the access_key you created on the previous step</span>
    <span class="na">secret_access_key</span><span class="pi">:</span> <span class="s">&lt;aws_secret_access_key&gt;</span> <span class="c1"># the secret_access_key you created on the previous step</span>
    <span class="na">region</span><span class="pi">:</span> <span class="s">&lt;aws_region&gt;</span>
</code></pre></div>    </div>

  </div>
  <div id="azure_file">

    <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">unity</span><span class="pi">:</span>
  <span class="na">url</span><span class="pi">:</span> <span class="s">&lt;unity_url&gt;</span> <span class="c1"># Your Databricks workspace URL. e.g. https://dbc-&lt;workspace-id&gt;.cloud.databricks.com</span>
  <span class="na">token</span><span class="pi">:</span> <span class="s">&lt;unity_token&gt;</span> <span class="c1"># The Personal access token you created during the Databricks Workspace preparation</span>
<span class="na">lakefs</span><span class="pi">:</span>
  <span class="na">secret_access_key</span><span class="pi">:</span> <span class="s">&lt;lakefs_secret_access_key&gt;</span> <span class="c1"># The secret_access_key you created during lakeFS Cloud setup</span>
  <span class="na">access_key_id</span><span class="pi">:</span> <span class="s">&lt;lakefs_access_key_id&gt;</span> <span class="c1"># The access_key_id you created during lakeFS Cloud setup</span>
  <span class="na">url</span><span class="pi">:</span> <span class="s">&lt;lakefs_endpoint_url&gt;/api/v1</span> <span class="c1"># The Url of your lakeFS Cloud instance e.g. https://example-org.us-east-1.lakefscloud.io </span>
<span class="na">databricks_storage</span><span class="pi">:</span>
  <span class="na">type</span><span class="pi">:</span> <span class="s">azure</span>
  <span class="na">azure</span><span class="pi">:</span>
    <span class="na">client_id</span><span class="pi">:</span> <span class="s">&lt;client_id&gt;</span> <span class="c1"># The client_id from the lakeFS Cloud Terraform output  </span>
    <span class="na">client_secret</span><span class="pi">:</span> <span class="s">&lt;client_secret&gt;</span> <span class="c1"># The client_secret from the lakeFS Cloud Terraform output</span>
    <span class="na">tenant_id</span><span class="pi">:</span> <span class="s">&lt;tenant_id&gt;</span> <span class="c1"># The tenant_id from the lakeFS Cloud Terraform output</span>
</code></pre></div>    </div>
  </div>
</div>
<h4 id="environment-variables">
  
  
    <a href="#environment-variables" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Environment variables
  
  
</h4>
    

<div class="tabs">
  <ul>
    <li><a href="#aws_env">AWS</a></li>
	<li><a href="#azure_env">Azure</a></li>
  </ul>
  <div id="aws_env">

    <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>LAKEFS_DATABRICKS_UNITY_URL=&lt;unity_url&gt;
LAKEFS_DATABRICKS_UNITY_TOKEN=&lt;unity_token&gt;
LAKEFS_DATABRICKS_LAKEFS_URL=&lt;lakefs_installation_url&gt;/api/v1
LAKEFS_DATABRICKS_LAKEFS_ACCESS_KEY_ID=&lt;lakefs_access_key_id&gt;
LAKEFS_DATABRICKS_LAKEFS_SECRET_ACCESS_KEY=&lt;lakefs_secret_access_key&gt;
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_TYPE=s3
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_S3_ACCESS_KEY_ID=&lt;aws_access_key_id&gt;
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_S3_SECRET_ACCESS_KEY=&lt;aws_secret_access_key&gt;
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_S3_REGION=&lt;aws_region&gt;
</code></pre></div>    </div>

  </div>
  <div id="azure_env">

    <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>LAKEFS_DATABRICKS_UNITY_URL=&lt;unity_url&gt;
LAKEFS_DATABRICKS_UNITY_TOKEN=&lt;unity_token&gt;
LAKEFS_DATABRICKS_LAKEFS_URL=&lt;lakefs_installation_url&gt;/api/v1
LAKEFS_DATABRICKS_LAKEFS_ACCESS_KEY_ID=&lt;lakefs_access_key_id&gt;
LAKEFS_DATABRICKS_LAKEFS_SECRET_ACCESS_KEY=&lt;lakefs_secret_access_key&gt;
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_TYPE=azure
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_AZURE_CLIENT_ID=&lt;client_id&gt;
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_AZURE_CLIENT_SECRET=&lt;client_secret&gt;
LAKEFS_DATABRICKS_DATABRICKS_STORAGE_AZURE_TENANT_ID=&lt;tenant_id&gt;
</code></pre></div>    </div>
  </div>
</div>
<h4 id="databricks-environment-variables">
  
  
    <a href="#databricks-environment-variables" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Databricks Environment variables
  
  
</h4>
    

<p>lakefs-databricks supports standard Databricks environment variables to simplify setup by reusing existing configurations. If these variables are already set for Databricks, lakefs-databricks will automatically use them, reducing redundant configuration.</p>
<h5 id="supported-variables">
  
  
    <a href="#supported-variables" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Supported Variables
  
  
</h5>
    
<ul>
  <li>DATABRICKS_HOST: Your Databricks workspace URL (e.g., https://dbc-<workspace-id>.cloud.databricks.com). Can be overridden by: LAKEFS_DATABRICKS_UNITY_URL or unity.url in the config file.</workspace-id></li>
  <li>DATABRICKS_TOKEN: Your Databricks Personal Access Token (PAT). Can be overridden by: LAKEFS_DATABRICKS_UNITY_TOKEN or unity.token in the config file.</li>
</ul>
<h2 id="command-reference">
  
  
    <a href="#command-reference" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Command Reference
  
  
</h2>
    

<p><strong>Options</strong></p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>-c, --config &lt;FILE&gt;  Config file to use
-h, --help           Print help
-V, --version        Print version
</code></pre></div></div>

<p><strong>Usage</strong></p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks <span class="o">[</span>OPTIONS] &lt;COMMAND&gt;
</code></pre></div></div>
<h3 id="commands">
  
  
    <a href="#commands" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Commands
  
  
</h3>
    
<h4 id="catalog-create">
  
  
    <a href="#catalog-create" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> catalog create
  
  
</h4>
    
<p>Create a versioned catalog</p>

<p><strong>Options</strong></p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>--force           
          Force creation of the catalog even if it already exists.

          If specified, the lakeFS repository will be re-associated with the provided Unity catalog. This may have undesired effects.
--sample-catalog  
          Add sample data to the created catalog
</code></pre></div></div>

<p><strong>Usage</strong></p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks catalog create <span class="o">[</span>OPTIONS] &lt;CATALOG_NAME&gt; &lt;LAKEFS_REPO_NAME&gt;
</code></pre></div></div>

<p><strong>Examples</strong></p>

<p>Create a catalog named “my_catalog” mapped to the LakeFS repository “my-repo”:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks catalog create my_catalog my-repo
</code></pre></div></div>
<p>Force-create the same catalog, with sample data:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks catalog create <span class="nt">--force</span> <span class="nt">--sample-catalog</span> my_catalog my-repo
</code></pre></div></div>
<h4 id="branch-create">
  
  
    <a href="#branch-create" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> branch create
  
  
</h4>
    
<p>Create a branch</p>

<p><strong>Usage</strong></p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks branch create &lt;CATALOG_NAME&gt; &lt;BRANCH_NAME&gt; &lt;SOURCE_BRANCH_NAME&gt;
</code></pre></div></div>
<p><strong>Examples</strong></p>

<p>Create a branch called “my-branch” from the source branch “main”, on the catalog “my_catalog”:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks branch create my_catalog my-branch main
</code></pre></div></div>
<h4 id="commit">
  
  
    <a href="#commit" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> commit
  
  
</h4>
    
<p>Record catalog changes</p>

<p><strong>Options</strong></p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>-m, --message &lt;MESSAGE&gt;  Commit message
</code></pre></div></div>

<p><strong>Usage</strong></p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks commit <span class="o">[</span>OPTIONS] &lt;CATALOG_NAME&gt; &lt;BRANCH_ID&gt;
</code></pre></div></div>

<p><strong>Examples</strong></p>

<p>Commit the changes on branch “my-branch” and catalog “my_catalog”, with commit message “Changes”:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks commit <span class="nt">-m</span> <span class="s2">"Changes"</span> my_catalog my-branch
</code></pre></div></div>
<h4 id="import">
  
  
    <a href="#import" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> import
  
  
</h4>
    
<p>Import table from an existing Unity catalog or from a lakeFS Delta table</p>

<p><strong>Options</strong></p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>-f, --from &lt;FROM_TABLE_PATH&gt;  Unity table to import: &lt;CATALOG&gt;.&lt;SCHEMA&gt;.&lt;TABLE&gt;
                              Or lakeFS table to import: lakefs://&lt;REPO&gt;/&lt;BRANCH&gt;/&lt;PATH_TO_TABLE&gt;
-t, --to &lt;TO_TABLE_PATH&gt;      lakeFS Databricks Unity table to generate: &lt;CATALOG&gt;.&lt;SCHEMA&gt;.&lt;TABLE&gt;
-h, --help                    Print help
</code></pre></div></div>

<p><strong>Usage</strong></p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks import <span class="nt">--from</span> &lt;FROM_TABLE_PATH&gt; <span class="nt">--to</span> &lt;TO_TABLE_PATH&gt;
</code></pre></div></div>

<p><strong>Examples</strong></p>

<p>Import table “my_table” from catalog and schema “src_catalog” and “src_schema” to catalog and schema “dst-catalog” and “main”:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks import <span class="nt">--from</span> src_catalog.src_schema.my_table <span class="nt">--to</span> dst_catalog.main.my_table 
</code></pre></div></div>

<p>Import table “my_lakefs_table” from lakeFS repository and branch “existing_repo” and “main” to a table named “my_table” in catalog and schema “dst_catalog” and “main”:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>lakefs-databricks import <span class="nt">--from</span> lakefs://existing_repo/main/_tables/my_lakefs_table <span class="nt">--to</span> dst_catalog.main.my_table 
</code></pre></div></div>

                
            </div>
        </div>

        
        <div class="search-overlay"></div>
        
    </div>
</div>

<footer>
    <div class="footer-sidebar"></div>
    <div class="footer-main">
        <div class="row">
            <div class="left">
                <ul class="footer-links">
                    
                    
                    <li class="aux-nav-list-item">
                        <a href="https://docs-databricks.lakefs.io/" class="site-button" >
                            Docs
                        </a>
                    </li>
                    
                    <li class="aux-nav-list-item">
                        <a href="https://docs-databricks.lakefs.io/blog/" class="site-button" >
                            Blog
                        </a>
                    </li>
                    
                    <li class="aux-nav-list-item">
                        <a href="https://docs-databricks.lakefs.io/community/" class="site-button" >
                            Community
                        </a>
                    </li>
                    
                    <li class="aux-nav-list-item">
                        <a href="https://docs-databricks.lakefs.io/contact-us/" class="site-button" >
                            Contact
                        </a>
                    </li>
                    
                    
                </ul>
            </div>
            <div class="right">
                <ul class="footer-social">
                    
                    
                    <li class="aux-nav-list-item">
                        <a href="https://docs-databricks.lakefs.io/youtube" class="site-button" >
                            <img src="/assets/icons/youtube.svg" class="no-hover" />
                            <img src="/assets/icons/youtube-hover.svg" class="hover" />
                        </a>
                    </li>
                    
                    <li class="aux-nav-list-item">
                        <a href="https://www.linkedin.com/company/treeverse" class="site-button" >
                            <img src="/assets/icons/linkedin.svg" class="no-hover" />
                            <img src="/assets/icons/linkedin-hover.svg" class="hover" />
                        </a>
                    </li>
                    
                    <li class="aux-nav-list-item">
                        <a href="https://github.com/treeverse/lakeFS" class="site-button" >
                            <img src="/assets/icons/github.svg" class="no-hover" />
                            <img src="/assets/icons/github-hover.svg" class="hover" />
                        </a>
                    </li>
                    
                    <li class="aux-nav-list-item">
                        <a href="https://twitter.com/lakeFS" class="site-button" >
                            <img src="/assets/icons/twitter.svg" class="no-hover" />
                            <img src="/assets/icons/twitter-hover.svg" class="hover" />
                        </a>
                    </li>
                    
                    <li class="aux-nav-list-item">
                        <a href="https://data-folks.masto.host/@lakeFS" class="site-button" >
                            <img src="/assets/icons/mastodon.svg" class="no-hover" />
                            <img src="/assets/icons/mastodon-hover.svg" class="hover" />
                        </a>
                    </li>
                    
                    <li class="aux-nav-list-item">
                        <a href="https://lakefs.io/slack" class="site-button" >
                            <img src="/assets/icons/slack.svg" class="no-hover" />
                            <img src="/assets/icons/slack-hover.svg" class="hover" />
                        </a>
                    </li>
                    
                    
                </ul>
            </div>
        </div>
        <div class="row top-border">
            <div class="left">
                <a href="https://docs-databricks.lakefs.io" class="lh-tight" style="margin-bottom: 0px;">
                    <div class="site-logo"></div>
                </a>                    
            </div>
            <div class="right">
                <ul class="bottom-footer-links">
                    
                    
                    <li class="aux-nav-list-item">
                        <a href="https://docs-databricks.lakefs.io/terms-of-use/" class="site-button" >
                            Terms of use
                        </a>
                    </li>
                    
                    <li class="aux-nav-list-item">
                        <a href="https://docs-databricks.lakefs.io/privacy-policy/" class="site-button" >
                            Privacy Policy
                        </a>
                    </li>
                    
                    
                </ul>
            </div>
        </div>
    </div>
</footer>


</body>

</html>