Skip to main content

Confluence connector reference

This page contains reference material for the Confluence connector in 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 (for example, current, draft, archived).

subtype

StringType

Subtype of the page (for example, live for live docs).

title

StringType

Title of the content as shown in the Confluence UI.

modifiedAt

TimestampType

Timestamp when the page was last modified. This is used as the cursor column.

parentId

StringType

ID of the parent content (for example, page or blog post) if this content is nested.

parentType

StringType

Type of parent content (for example, page, blogpost).

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 (might 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 (for example, storage for raw format, view for rendered HTML, editor for the legacy editor).

atlas_doc_format.value

StringType

The actual content string or structure.

_links

StructType

URLs for viewing, editing, or accessing content using 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.

web_url

StringType

Fully-qualified URL to view the page in the Confluence UI.

version

StructType

Version metadata for the page.

version.number

LongType

Monotonically increasing version number for the page.

version.message

StringType

Optional version message supplied at edit time.

version.minorEdit

BooleanType

Whether this version was saved as a minor edit.

version.authorId

StringType

ID of the user who created the version.

version.createdAt

TimestampType

Timestamp when the version was created.

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 (for example, "Engineering", "Marketing Docs").

type

StringType

Type of space (usually global or personal).

status

StringType

Current lifecycle state of the space (for example, 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 (for example, plain for unformatted text, view for rendered HTML).

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 (for example, 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 using the UI or API.

_links.webui

StringType

Link to view the page in the normal Confluence UI.

web_url

StringType

Fully-qualified URL to view the space in the Confluence UI.

labels

Field

Data type

Notes

id

StringType

Unique identifier of the label.

name

StringType

The label's actual text value (for example, engineering, draft).

prefix

StringType

The type of label, indicating scope (for example, global, my).

classification_levels

Field

Data type

Notes

id

StringType

Unique identifier for the classification level.

status

StringType

Current lifecycle status (for example, current or archived).

order

LongType

Display order of the classification level relative to other levels.

name

StringType

Human-readable name of the classification level (for example, "Confidential").

description

StringType

Description of the classification level.

guideline

StringType

Guidance text describing when the classification level should be applied.

color

StringType

Display color associated with the classification level.

blogposts

Field

Data type

Notes

id

StringType

Unique identifier of the blog post.

status

StringType

Lifecycle state (for example, 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.

body.storage

StructType

Storage-format representation of the blog post body.

body.storage.representation

StringType

Specifies the format type for the content (typically storage).

body.storage.value

StringType

The blog post body in Confluence storage XHTML format.

body.atlas_doc_format

StructType

Atlas document format representation of the blog post body.

body.atlas_doc_format.representation

StringType

Specifies the format type for the content (typically atlas_doc_format).

body.atlas_doc_format.value

StringType

The blog post body in atlas document format (JSON string).

_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.

web_url

StringType

Fully-qualified URL to view the blog post in the Confluence UI.

version

StructType

Version metadata for the blog post.

version.number

LongType

Monotonically increasing version number for the blog post.

version.message

StringType

Optional version message supplied at edit time.

version.minorEdit

BooleanType

Whether the version was saved as a minor edit.

version.authorId

StringType

ID of the user who created the version.

version.createdAt

TimestampType

Timestamp when the version was created.

isDeleted

BooleanType

Indicates whether the blog post is deleted (true) or not (false).

attachments

Field

Data type

Notes

id

StringType

Unique identifier for the attachment.

status

StringType

Lifecycle state of the attachment (for example, 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 (a non-standard content type, for example, a whiteboard created with the Confluence whiteboards feature).

mediaType

StringType

MIME type of the file (for example, image/png, application/pdf).

mediaTypeDescription

StringType

Human-readable description of the file type (for example, "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 using the UI or API.

version

StructType

Version metadata for the attachment.

version.number

LongType

Monotonically increasing version number for the attachment.

version.message

StringType

Optional version message supplied at edit time.

version.minorEdit

BooleanType

Whether the version was saved as a minor edit.

version.authorId

StringType

ID of the user who created the version.

version.createdAt

TimestampType

Timestamp when the version was created.

web_url

StringType

Fully-qualified URL to view the attachment in the Confluence UI.

isDeleted

BooleanType

Indicates whether the attachment has been deleted.