Confluence

Confluence is a collaborative workspace software developed by Atlassian, designed to help teams create, organize, and share knowledge efficiently. It's a versatile tool widely used in various industries for project management, documentation, and collaboration.

To learn how Confluence entities map to SQL tables, consult the table mappings guide.

How to Setup

To connect to a Confluence data source you need to register the Confluence credentials. This requires:

• The name of the credential (which you can choose).
• Base URL.
• Username.
• Token.

Using our App, this is the respective form for adding Confluence credentials:

Base URL

This is the site url of the user's attlassian jira subscription., e.g. https://your-domain.atlassian.net/

Username

The user name to access the jira cloud instance, e.g. user@domain.com

Token

API token for the user's Atlassian account. API tokens are created and managed here.

Examples

Choose one of the examples below:

Get content body in the storage format

Retrieve the content body in the storage format.

Overview

Sample usage:

/confluence/content_body_storage/format

Code

select
  *
from
   <credentials_name>.confluence_content_body_storage
where
  representation = 'storage';

Get content that mentions steampipe in the body

Retrieve content that includes references to steampipe within the main text.

Overview

Sample usage:

/confluence/content_body_storage/memtions/steampipe

Code

select
  id,
  value
from
   <credentials_name>.confluence_content_body_storage
where
  "value" ilike '%steampipe%';

Get content body in the view format

Retrieve the body content in the specified format for viewing.

Overview

Sample usage:

/confluence/content_body_view/format

Code

select
  *
from
   <credentials_name>.confluence_content_body_view
where
  representation = 'view';

Get content that mentions steampipe in the body

Retrieve content that includes references to steampipe within the body.

Overview

Sample usage:

/confluence/content_body_view/stats/mentions/steampipe

Code

select
  id,
  value
from
   <credentials_name>.confluence_content_body_view
where
  "value" ilike '%steampipe%';

Get content with draft in the title

Retrieve content that has "draft" in the title.

Overview

Sample usage:

/confluence/content/draft

Code

select
  *
from
   <credentials_name>.confluence_content
where
  title ilike '%draft%';

Get basic info about the content

Retrieve fundamental information regarding the content.

Overview

Sample usage:

/confluence/content/information

Code

select
  id,
  title,
  space_key,
  status,
  type
from
   <credentials_name>.confluence_content;

Get basic info about the labels

Retrieve fundamental information regarding the labels.

Overview

Sample usage:

/confluence/content_label/basic_info

Code

select
  id,
  content_id,
  title,
  space_key,
  prefix,
  name,
  label
from
   <credentials_name>.confluence_content_label;

Get the count of content by label

Query the number of pieces of content based on their label.

Overview

Sample usage:

/confluence/content_label/count

Code

select
  label,
  count(*)
from
   <credentials_name>.confluence_content_label
group by
  label;

Get labels with documentation in the name

Retrieve labels that contain documentation in their name.

Overview

Sample usage:

/confluence/content_label/documentation

Code

select
  *
from
   <credentials_name>.confluence_content_label
where
  name ilike '%documentation%';

Get the count of content type

Retrieve the number of content types.

Overview

Sample usage:

/confluence/content/type/count

Code

select
  "type",
  count(*)
from
   <credentials_name>.confluence_content
group by
  "type";

Get basic info about the version

Retrieve fundamental details regarding a version.

Overview

Sample usage:

/confluence/content_version/basic_info

Code

select
  *
from
   <credentials_name>.confluence_content_version;

Get the count of content by label

Retrieve the label-based content count.

Overview

Sample usage:

/confluence/content_version/count_by_label

Code

select
  label,
  count(*)
from
   <credentials_name>.confluence_content_version
group by
  label;

Get the 50 oldest pages

Retrieve the 50 oldest pages.

Overview

Sample usage:

/confluence/content_version/pages/oldest_limit_50

Code

select
  title,
  space_key,
  "when"
from
   <credentials_name>.confluence_content_version
  join  <credentials_name>.confluence_content using (id)
order by
  "when" asc
limit
  50;

Get content with type "blogpost"

Retrieve content of type "blogpost".

Overview

Sample usage:

/confluence/search_content/blogposts

Code

select
  id,
  title,
  status,
  type,
  last_modified
from
   <credentials_name>.confluence_search_content
where
  cql = 'type=blogpost';

Get content with the "soc2" label

Retrieve content labeled as 'soc2'.

Overview

Sample usage:

/confluence/search_content/soc2

Code

select
  id,
  title,
  status,
  type,
  last_modified
from
   <credentials_name>.confluence_search_content
where
  cql = 'label=soc2';

Get personal, archived spaces

Retrieve personal, archived spaces.

Overview

Sample usage:

/confluence/space/archive/personal

Code

select
  *
from
   <credentials_name>.confluence_space
where
  "type" = 'personal'
  and status = 'archived';

Get basic info about the spaces

Retrieve fundamental information regarding the spaces.

Overview

Sample usage:

/confluence/space/basic_info

Code

select
  id,
  key,
  name,
  type,
  status
from
   <credentials_name>.confluence_space;

Get the global spaces

Retrieve the global spaces.

Overview

Sample usage:

/confluence/space/global

Code

select
  *
from
   <credentials_name>.confluence_space
where
  "type" = 'global';

Table Mappings

Once the Confluence credential is registered, a new schema will be available for query within RAW. The name of this schema matches the name of the "RAW credential" you chose above.

Within this schema, you will find a set of tables, which contain the information stored in confluence. These tables are:

Table Name	Description
confluence_content	Content
confluence_content_body_storage	Content Body Storage
confluence_content_body_view	Content Body View
confluence_content_label	Content Label
confluence_content_version	Content Version
confluence_search_content	Search Content
confluence_space	Space

Content

Information stored within a Confluence platform.

Fields

Name	Type	Description
_ctx	jsonb	Steampipe context in JSON form, e.g. connection_name.
id	text	Automatically assigned when the content is created
space_key	text	The space containing the content
status	text	The content status
title	text	The content title
type	text	The content type (page, blogpost, attachment or content)
version_number	bigint	The content version

Content Body Storage

Body of content stored in the format used by Confluence instance.

Fields

Name	Type	Description
_ctx	jsonb	Steampipe context in JSON form, e.g. connection_name.
id	text	The ID of the content.
representation	text	The representation type of the content.
value	text	The content body.

Content Body View

Content text from a Confluence instance in view format

Fields

Name	Type	Description
_ctx	jsonb	Steampipe context in JSON form, e.g. connection_name.
id	text	The ID of the content.
representation	text	The representation type of the content.
value	text	The content body.

Content Label

Labels for content within a Confluence instance.

Fields

Name	Type	Description
_ctx	jsonb	Steampipe context in JSON form, e.g. connection_name.
content_id	text	Automatically assigned when the content is created
id	text	Automatically assigned when the label is created
label	text	The label
name	text	The label name
prefix	text	The label prefix
space_key	text	The space containing the content
title	text	The content title

Content Version

Different versions of content stored in a Confluence instance.

Fields

Name	Type	Description
_ctx	jsonb	Steampipe context in JSON form, e.g. connection_name.
accountId	text	The account ID for the content version's author.
displayName	text	The display name for the content version's author.
email	text	The email for the content version's author.
id	text	The ID of the content.
message	text	The content version message.
minor_edit	boolean	Whether the version corresponds to a minor edit.
number	bigint	The content version number.
userKey	text	The user key for the content version's author.
username	text	The username for the content version's author.
when	text	When the content version was published.

Search Content

Find information within a Confluence instance.

Fields

Name	Type	Description
_ctx	jsonb	Steampipe context in JSON form, e.g. connection_name.
cql	text	The Confluence query langauge.
id	text	Automatically assigned when the content is created.
last_modified	text	When the content was last modified
status	text	The content status
title	text	The content title
type	text	The content type (page, blogpost, attachment or content)

Space

Areas within a Confluence system.

Fields

Name	Type	Description
_ctx	jsonb	Steampipe context in JSON form, e.g. connection_name.
id	text	Automatically assigned when the space is created
key	text	The key of the space.
name	text	The name of the space.
status	text	The status of the space.
type	text	The type of space.