GitHub connector reference

Important

This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Azure Databricks previews.

This page contains reference documentation for the GitHub connector in Lakeflow Connect.

Connection properties

When you create the Unity Catalog connection, you must specify the following properties for OAuth U2M authentication. These values come from the GitHub OAuth App you configured in Configure OAuth U2M for GitHub ingestion.

Property Required Description
Client ID Yes The client ID from your GitHub OAuth App.
Client secret Yes The client secret from your GitHub OAuth App. This value is displayed only once when you generate it.
Enterprise domain No Your GitHub Enterprise Server (GHES) hostname, if applicable (for example, github.mycompany.com). Leave empty for github.com and GitHub Enterprise Cloud (GHEC). If not set, defaults to api.github.com.

Supported source tables

For information about which tables support incremental updates and which are fully refreshed on each pipeline run, see Supported data.

Repository contents (repo_contents table)

The repo_contents table ingests all entries in each repository's default branch, including files, directories, submodules, and symbolic links. The primary key is (repository_id, branch_name, path). The type column identifies each entry as a blob (file), tree (directory), or commit (submodule). Symbolic links are blob entries with a mode of 120000. Only file (blob) entries populate the content column, which holds the decoded text content. When a file is deleted from the source repository, its row is removed from the table (hard delete). For limitations, see Repository contents.