Confluence connector reference

Preview

The Confluence connector is in Beta.

This page contains reference material for the Confluence connector in Databricks Lakeflow Connect.

General connector behavior

Page hierarchy is preserved through parent-child relationship fields in the pages table.

Automatic data transformations

Databricks automatically transforms the following Confluence data types to Delta-compatible data types.

Schemas

`pages`

Field	Data type	Notes
`id`	`StringType`	Unique identifier of the page.
`status`	`StringType`	Current lifecycle state of the page (e.g., current, draft, archived).
`title`	`StringType`	Title of the content as shown in the Confluence UI.
`modifiedAt`	`TimestampType`	Timestamp when the blog post was last modified. This is used as the cursor column.
`parentId`	`StringType`	ID of the parent content (e.g., page or blog post) if this content is nested.
`parentType`	`StringType`	Type of parent content (page, blogpost, etc.).
`position`	`LongType`	Location index of a page within a list of sibling pages or content.
`authorId`	`StringType`	ID of the user who originally created the content.
`ownerId`	`StringType`	ID of the current owner of the content (may differ from the author).
`lastOwnerId`	`StringType`	ID of the previous owner of the content.
`createdAt`	`TimestampType`	Timestamp when the content was initially created.
`spaceId`	`StringType`	ID of the space to which the content belongs.
`body`	`StructType`	Container that holds the actual content of the page in one or more representations.
`storage`	`StructType`	Raw XHTML content format stored in Confluence.
`storage.representation`	`StringType`	Specifies the format type for the content.
`storage.value`	`StringType`	The actual content string (plain text, HTML, or storage XHTML depending on the representation).
`atlas_doc_format`	`StructType`	JSON format for pages made in the new editor.
`atlas_doc_format.representation`	`StringType`	Format type of the content (e.g., storage for raw format, view for rendered HTML, editor for the legacy editor, etc.).
`atlas_doc_format.value`	`StringType`	The actual content string or structure.
`_links`	`StructType`	URLs for viewing, editing, or accessing content via the UI or API.
`_links.webui`	`StringType`	Link to view the page in the normal Confluence UI.
`_links.editui`	`StringType`	Link to edit the page in the legacy editor.
`_links.tinyui`	`StringType`	Short, shareable URL for the page.
`_links.edituiv2`	`StringType`	Link to edit the page in the new (fabric) editor.
`isDeleted`	`BooleanType`	Indicates whether the content is deleted (true) or not (false).

`spaces`

Field	Data type	Notes
`id`	`StringType`	Unique identifier of the space.
`key`	`StringType`	Unique identifier string for a space, used in URLs like https://your-site.atlassian.net/wiki/spaces/{KEY}
`name`	`StringType`	Display name of the space (e.g., "Engineering", "Marketing Docs").
`type`	`StringType`	Type of space (usually global or personal).
`status`	`StringType`	Current lifecycle state of the space (e.g., current, draft, archived).
`authorId`	`StringType`	ID of the user who created the space.
`createdAt`	`TimestampType`	Timestamp when the space was created.
`homepageId`	`StringType`	ID of the home page for this space.
`description`	`StructType`	Container for different representations of the space description (e.g., plain for unformatted text, view for rendered HTML, etc.).
`plain`	`StructType`	Text-only representation of content, with no formatting (used under fields like description.plain).
`plain.representation`	`StringType`	Specifies the format type for the content.
`plain.value`	`StringType`	The actual content string (plain text, HTML, or storage XHTML depending on the representation).
`view`	`StructType`	Rendered HTML view of the description as seen in the UI.
`view.representation`	`StringType`	Specifies the format type for the content.
`view.value`	`StringType`	The actual content string (plain text, HTML, or storage XHTML depending on the representation).
`icon`	`StructType`	Icon metadata associated with the space (e.g., custom logo or default avatar).
`path`	`StringType`	Relative path to the space's icon or base page (used in URLs).
`apiDownloadLink`	`StringType`	API endpoint to download the space icon or attachment (if applicable).
`_links`	`StructType`	URLs for viewing, editing, or accessing content via the UI or API.
`_links.webui`	`StringType`	Link to view the page in the normal Confluence UI.

`labels`

Field	Data type	Notes
`id`	`StringType`	Unique identifier of the label.
`name`	`StringType`	The label's actual text value (e.g., engineering, draft).
`prefix`	`StringType`	The type of label, indicating scope (e.g., global, my).

`classiciation_levels`

Field	Data type	Notes
`id`	`StringType`	Unique identifier for the classification level.
`key`	`StringType`	URL-friendly string used as a unique key for the level.
`name`	`StringType`	Human-readable name of the classification level (e.g., "Confidential").
`type`	`StringType`	Type or category of the classification level.
`status`	`StringType`	Current lifecycle status (e.g., active, archived).
`authorId`	`StringType`	ID of the user who created the classification level.
`createdAt`	`TimestampType`	Timestamp when the classification level was created.
`homepageId`	`StringType`	ID of the associated homepage or main content, if applicable.
`description`	`StructType`	A container for different representations of the classification level description (e.g., plain for unformatted text, view for rendered HTML, etc.).
`plain`	`StructType`	Plain-text version of the description (no formatting).
`plain.representation`	`StringType`	Specifies the format type for the content.
`plain.value`	`StringType`	The actual content string (plain text, HTML, or storage XHTML depending on the representation).
`view`	`StructType`	HTML-rendered version of the description for display purposes.
`view.representation`	`StringType`	Specifies the format type for the content.
`view.value`	`StringType`	The actual content string (plain text, HTML, or storage XHTML depending on the representation).
`icon`	`StructType`	Icon metadata for the classification level (e.g., URL, path, size).
`path`	`StringType`	Relative path to the classification icon or main page.
`apiDownloadLink`	`StringType`	API endpoint to download the icon or attachment, if present.
`_links`	`StructType`	Collection of related web or API links for this classification level.
`_links.webui`	`StringType`	Link to view the classification level in the Confluence UI.

`blogposts`

Field	Data type	Notes
`id`	`StringType`	Unique identifier of the blog post.
`status`	`StringType`	Lifecycle state (e.g., current, draft, archived).
`title`	`StringType`	Title of the blog post.
`modifiedAt`	`TimestampType`	Timestamp when the blog post was last modified. This is used as the cursor column.
`spaceId`	`StringType`	ID of the space the blog post belongs to.
`authorId`	`StringType`	ID of the user who created the blog post.
`createdAt`	`TimestampType`	Timestamp when the blog post was created.
`body`	`StructType`	Container for the actual content of the blog post in one or more formats.
`_links`	`StructType`	Contains URLs for viewing or editing the blog post.
`_links.webui`	`StringType`	Link to view the blog post in the standard Confluence UI.
`_links.editui`	`StringType`	Link to edit the blog post in the legacy editor.
`_links.tinyui`	`StringType`	Short, shareable URL for the blog post.
`isDeleted`	`BooleanType`	Indicates whether the blog post is deleted (true) or not (false).

`attachments`

Field	Data type	Notes
`status`	`StringType`	Lifecycle state of the attachment (e.g., current, deleted).
`title`	`StringType`	Filename/title of the attachment.
`createdAt`	`TimestampType`	Timestamp when the attachment was uploaded.
`modifiedAt`	`TimestampType`	Timestamp of the last modification to the attachment. This is used as the cursor column.
`pageId`	`StringType`	ID of the page that the attachment is linked to.
`blogpostId`	`StringType`	ID of the blog post that the attachment is linked to (if applicable; NULL if not).
`customContentId`	`StringType`	ID for custom content types using attachments. Typically used when it's not linked to a page or blog post—i.e., a non-standard content type (e.g., a whiteboard created with the Confluence whiteboards feature).
`mediaType`	`StringType`	MIME type of the file (e.g., image/png, application/pdf).
`mediaTypeDescription`	`StringType`	Human-readable description of the file type (e.g., "PNG image").
`comment`	`StringType`	Optional comment or note added to the attachment.
`fileId`	`StringType`	Unique ID of the attachment file itself.
`fileSize`	`LongType`	Size of the file in bytes.
`webuiLink`	`StringType`	Link to view the attachment in the Confluence UI.
`downloadLink`	`StringType`	Direct URL to download the attachment.
`_links`	`StructType`	Object containing structured links related to the attachment.
`_links.webui`	`StringType`	Relative link to view the attachment in the web UI.
`_links.download`	`StringType`	Relative link to download the attachment via the UI or API.
`isDeleted`	`BooleanType`	Indicates whether the attachment has been deleted.

General connector behavior​

Automatic data transformations​

Schemas​

pages​

spaces​

labels​

classiciation_levels​

blogposts​

attachments​