Was this page helpful?
Yes No

Workgroups Database

Introduction

The following "data dictionary" provides information about the tables and views in the "workgroup" PostgreSQL database of the Tableau Server repository. This database provides persistent storage for Tableau Server and is primarily intended to support that application.

The purpose of most tables is described, along with the type and purpose of columns in the tables. Foreign key relations are noted in orange rows with links that take you from the table containing the foreign key to the primary key table. This is not an exhaustive description of all tables and fields in the database, but is provided here for those customers who want to query it for information about their Tableau Server usage. This information is provided with a caution that because the purpose of these tables and views is primarily to support Tableau Server, their structure and contents may change without warning and as a result, any custom views built from them may break.

Note: All timestamps are in UTC time.

Contents

Tables (these are available to the "readonly" user)

Table Name Description
asset_key_marker Records are used to flag a particular record in the asset_key_meta_data table.
asset_key_meta_data Each record holds meta data for an asset encryption key.
asset_list_items Contains the individual list entries that correspond to the lists defined in the asset_lists table.
asset_lists This table supports the creation of various types of per-user lists. The actual list contents are listed in the asset_list_items table.
async_jobs Records information about background tasks that are run in response to some user action (as opposed to being run on some schedule).
background_jobs Records information about background tasks that are run by a Backgrounder process. These tasks are almost always run according to some schedule, but in a few cases they may also be triggered by some user actions.
big_texts This table serves as a convenient place to store a big text object, if necessary. It's kind of a utility table. This table is really just used for internal purposes.
capabilities Holds a relatively short list of capabilities. A user can be allowed certain capabilities either through being some sort of admin, or through owning something like a workbook or a project, or via entries in the next_gen_permissions table. Capabilities are things like read, write, export_data, publish, web_authoring, etc.
capability_roles This table serves primarily to associate roles with capabilities. A given role can have many capabilities, and a given capability can be associated with several roles.
comments Comments users made on views.
customized_views When a user creates a customized view, the data that supports that goes in this table.
data_alerts Each record represents an alert. An alert is a predefined data conditions on a view, and if conditions are met all alert recipients get notified.
data_alerts_recipients Each record represents the intent of recipient to be notified if an event is triggered.
data_connections Describes various data sources that are included in either workbooks or datasources.
datasource_metrics_aggregations Each record represents a partial aggregation of analytics for a given datasource in a given time interval. It is often necessary to sum across multiple rows to find a total for a given time interval.
datasource_refresh_properties Extension of datasources table for refresh properties (Online). This is 1-0/1 relationship to datasources table. It is a separate table since it contains Online-specific properties.
datasource_versions Datasource versions saved on server.
datasources Records all Published datasources on server.
desktop_reporting Missing description
domains Records represent either an Active Directory domain or an authenticate system.
extract_sessions Extracts that have active vizql sessions.
extracts Each record corresponds to a directory that contains one or more extract files associated with either a workbook or datasource.
group_users Serves as a many to many linking mechanism between users and groups. A user can belong to multiple groups, and a group can contain multiple users.
groups A grouping of users. Can be locally created or imported from Active Directory.
hist_capabilities Records the most useful information about a capability that was relevant at the time of the event (see capabilities table).
hist_comments Records the most useful information about a comment that was relevant at the time of the event (see comments table).
hist_configs Can be used to record information about configuration that was in effect at the time of the historical event.
hist_data_connections Records the most useful information about a data connection that was relevant at the time of the event (see data_connections table).
hist_datasources Records the most useful information about a data source that was relevant at the time of the event (see datasources table).
hist_groups Records the most useful information about a group that was relevant at the time of the event (see groups table).
hist_licensing_roles Records the most useful information about a licensing role that was relevant at the time of the event (see licensing_roles table).
hist_projects Records the most useful information about a project that was relevant at the time of the event (see projects table).
hist_schedules Records the most useful information about a schedule that was relevant at the time of the event (see schedules table).
hist_sites Records the most useful information about a site that was relevant at the time of the event (see sites table).
hist_tags Records the most useful information about a tag that was relevant at the time of the event (see tags table).
hist_tasks Records the most useful information about a task that was relevant at the time of the event (see tasks table).
hist_users Records the most useful information about a user and corresponding system_user that was relevant at the time of the event (see users and system_users tables).
hist_views Records the most useful information about a view that was relevant at the time of the event (see views table).
hist_workbooks Records the most useful information about a workbook that was relevant at the time of the event (see workbooks table).
historical_disk_usage Records historical disk utilization by Tableau Server for storage monitoring.
historical_event_types The types of historical events which can be recorded.
historical_events This table is the heart of the cluster of tables devoted to historical event auditing. For each event, a record is created on this table. The type of event is indicated through historical_event_type_id, which links to the historical_event_types table. Other information relevant to the event is linked through some of the other id fields in this table. Note these links go to other hist* tables, which allows the event to refer to things that might have since been deleted from the regular tables.
http_requests Each record represents a request received by Tableau Server.
language_prefs Contains a listing of information about languages for which Tableau Server has been localized.
licensing_roles Lists the various possible licensing scenarios. (Unlicensed, Guest, Viewer, or Interactor).
local_names Contains translations of certain words or phrases that are relevant to some Tableau Server database constructs.
mobile_enrollments Keeps track of most recent time a user has been enrolled for a mobile device. User will typically be enrolled onto server by logging into server through the mobile client. A user may be enrolled under multiple devices if the devices have different attributes (pixel width, pixel height, pixel ratio)
most_recent_refreshes most recent refresh data for alerts
mru_list_entries Holds most recently used list entries. The records here are linked to the lists to which they belong. Those lists are defined in the mru_lists table.
mru_lists Most recently used lists by user. The actual list contents are in the mru_list_entries table.
next_gen_permissions This table provides a flexible means of describing which users and groups have been granted which capabilities, on which things. Be aware that permissions is a complex topic and that this table does not contain all relevant information about permissions. For example, some permissions are given, automatically, to owners of workbooks or projects.
oauth_request_tokens Missing description
password_tokens Tokens issued to client through link in email which can be redeemed to change their password
permission_reasons When calculating effective permissions in the perm_users_*_capabilities functions, this table maps the integer precedence of the effective permission rule to the varchar effective permission reason. The integer precedence is internal to the stored procedures. The effective permission reason is returned to callers.
permissions_templates This table provides a flexible means of describing which users and groups will be granted which capabilities by default, on non-overwrite publishes of workbooks and datasources. Be aware that permissions is a complex topic and that this table does not contain all relevant information about permissions. For example, some permissions are given, automatically, to owners of workbooks or projects.
projects Each row of the table corresponds to a project on Tableau Server.
refresh_token_devices Devices that have been issued at least one refresh token
refresh_tokens Tokens issued to clients which can be redeemed by the client for access to the server
remote_agents Registry of remote agents (Online). Remote agents are programs installed on customer PC and executing tasks on a behalf of a customer. The first example of agent is Tableau Data Sync. It is running in background on customer desktop and performing automatic data source refreshes based on schedules defined by customers.
repository_data This table forms the link between other tables that need to store "large object" data, and the large object storage, itself, which is in the pg_largeobject system table.
roles This table contains records corresponding to various classifications of users. It should really be viewed in conjuction with the capabilities and capability_roles tables. Taken together, these tables associate different roles with different sets of capabilities. The capabilities sets serve as templates when creating content.
schedules Records in this table define a schedule according to which certain regular tasks may be performed (see tasks table). They also indicate the next time at which the schedule will be triggered.
schema_migrations This table tracks which database migrations have been applied to this database.
serial_collections Records in this table represent groups of background jobs that should not be run simultaneously.
sessions Settings associated with a user's browser session.
sheet_images Serves as a cache for all the sheet images generated by server.
site_logos custom logo image metadata for sites
site_oidc_configurations Defines the OpenID Connect IdP associated with a site.
site_saml_configurations Defines the SAML IdP associated with a site.
site_saml_events Log table for all SAML actions.
site_saml_sessions Records the user sessions authenticated by the SiteSAML service.
site_saml_users Users that are allowed to use Per Site SAML authentication.
site_user_prefs Site user preferences.
sites Each record represents a site. Each site holds its own workbooks, datasources, users, etc. Strict isolation between the contents of each site is maintained.
subscriptions Each record represents a subscription.
subscriptions_customized_views This table is used to link various customized views to the subscriptions in which those customized views must be generated and emailed.
subscriptions_views This table is used to link various views to the subscriptions in which those views must be generated and emailed.
subscriptions_workbooks This table is used to link various workbooks to the subscriptions in which those workbooks must have views generated and emailed.
system_users Each record represents a user of the server. These records correspond to login identity. A single system_user may potentially be able to login to multiple sites. The linkage between a system_user and their allowed sites is defined through the "users" table.
taggings Associates tags with taggable items.
tags Each tag is a string value. A given tag can be associated with many taggable items in a site.
tasks Serves to connect schedules with background tasks that should be run on that schedule. The schedule is defined in the schedules table, while the task is defined by type.
trusted_tickets This table lists trusted tickets that have been created. Tickets that are redeemed are deleted once used, hence can only be used once. Tickets that are never redeemed become invalid after the time given by "expires_at" and are eventually deleted from the table automatically.
user_default_customized_views Defines what customized view a user should see for a given view, by default.
user_images Missing description
user_prefs Contains a variety of preferences for the various system users.
users Each record links a system_users record to a site. The user's site specific settings are captured here.
view_metrics_aggregations Each record represents a partial aggregation of analytics for a given view in a given time interval. It is often necessary to sum across multiple rows to find a total for a given time interval.
views Each records represents a view in a workbook.
views_stats This table is used to track how many times each user has accessed different views.
workbook_checksums This table provides a set of checksums associated with a workbook which can be used to validate existence of a workbook based on its checksum.
workbook_versions Workbook versions saved on server.
workbooks Each record represents a workbook that exists on the server.

Views (these are available to both the "tableau" and the "readonly" users)

View Name Description
_background_tasks This view combines the important contents of both the background_jobs table and the async_jobs table to give an overall picture of jobs that were given to a backgrounder process.
_comments Comments users made on views.
_customized_views When a user creates a customized view, the data that supports that goes in the customized_views table, and is reflected in this view.
_datasources Shows all Published datasources on server, along with some associated information.
_datasources_stats Some historical useage information about datasources. Based on the records that exist in the historical events tables.
_groups A grouping of users. Can be locally created or imported from Active Directory. Reflects the contents of the groups table and associated tables.
_http_requests Each record represents a request received by Tableau Server. Reflects data in the http_requests table.
_projects Each row of the table corresponds to a project on Tableau Server.
_schedules Records define a schedule according to which certain regular tasks may be performed (see tasks table). They also indicate the next time at which the schedule will be triggered.
_sessions Settings associated with a user's browser session.
_sites Each record represents a site. Each site holds its own workbooks, datasources, users, etc. Strict isolation between the contents of each site is maintained.
_subscriptions Each record provides information about subscriptions that are scheduled. Subscriptions are a mechanism for receiving specified content by email on some schedule.
_system_users Each record represents a user of the server. These records correspond to login identity. A single system_user may potentially be able to login to multiple sites. The linkage between a system_user and their allowed sites is defined through the "users" table.
_tags Each tag is a string value. A given tag can be associated with many taggable items in a site.
_users Information relating to users.
_views Each records represents a view in a workbook.
_views_stats Used to track how many times each user has accessed different views.
_workbooks Each record represents a workbook that exists on the server.
users_view Each record corresponds to a user on the system. The data presented is a combination of user data and data from the linked system_user.
asset_key_marker: Records are used to flag a particular record in the asset_key_meta_data table.
Name Type Description
id integer Artificial auto-incrementing integer that serves as the primary key
asset_key_id integer The id of the asset_key_meta_data record being marked.
marker_name character varying The type of marker.
created_at timestamp without time zone When this record was created.
updated_at timestamp without time zone When this records was last updated.
asset_key_meta_data: Each record holds meta data for an asset encryption key.
Name Type Description
id integer Artificial auto-incrementing integer that serves as the primary key.
algorithm_name character varying The algorithm used in conjunction with this key.
salt character varying The salt used in the test string.
test_string character varying An encrypted version of a well-known test string
created_at timestamp without time zone When this record was created.
updated_at timestamp without time zone When this record was last updated.
asset_list_items: Contains the individual list entries that correspond to the lists defined in the asset_lists table.
Name Type Description
Foreign key/Primary key relation from asset_list_id on this table to id on table, asset_lists
id integer Primary key for the record
asset_list_id integer A foreign key reference to the asset list to which this item belongs.
useable_type character varying One of "View" or "Workbook". The type of object that this item corresponds to.
useable_id integer Kind of an informal "polymorphic" foreign key reference to either the corresponding view or workbook as determined by the useable_type field. Dead links might exist, where the corresponding item has been deleted.
position integer Controls the order in which the items are displayed.
asset_lists: This table supports the creation of various types of per-user lists. The actual list contents are listed in the asset_list_items table.
Name Type Description
Foreign key/Primary key relation from owner_id on this table to id on table, users
Foreign key/Primary key relation from site_id on this table to id on table, sites
id integer Primary key for the record
name character varying This is what the type of list is called.
owner_id integer Foreign key to the user for whom this list was defined.
site_id integer Foreign key to the site to which the user belongs.
async_jobs: Records information about background tasks that are run in response to some user action (as opposed to being run on some schedule).
Name Type Description
id integer Primary key for the record
job_type character varying The type of job being run
success boolean Whether or not the job succeeded. Will be true for success, and false for failure.
worker character varying Identifies the machine on which the job is run
user_id integer Links to the user who triggered the running of the job.
site_id integer Links to the relevant site.
notes text Can be used to store additional information about the running of the job.
progress integer Can be used to indicate percent complete for the job, but in most cases simply gets set to 100 when the job is completed
created_at timestamp without time zone When this record was created.
updated_at timestamp without time zone When this record was last updated.
completed_at timestamp without time zone When the job finished execution. When set, this should generally agree with the updated_at field.
detailed_status text Stores information about current progress details of the async job.
luid uuid An identifier that is unique in combination with the site_id.
background_jobs: Records information about background tasks that are run by a Backgrounder process. These tasks are almost always run according to some schedule, but in a few cases they may also be triggered by some user actions.
Name Type Description
Foreign key/Primary key relation from site_id on this table to id on table, sites
id integer Primary key for the record.
job_type character varying The type of job being run. This looks a bit odd because it comes from a serialized symbol.
progress integer Can be used to indicate percent complete for the job, but in most cases simply gets set to 100 when the job is completed.
args text Used as a means of passing parameters about the background job. This information is stored in a special serialized format, and thus is not easily readable.
notes text Can be used to store additional information about the running of the job.
updated_at timestamp without time zone When this record was last updated
created_at timestamp without time zone When this record was created.
completed_at timestamp without time zone When the job finished execution. When set, this should generally agree with the updated_at field.
started_at timestamp without time zone When the execution of the job was started. This is not generally the same as created_at, because it may take some time before a backgrounder "notices" the newly created record and begins to process it.
job_name character varying A nice readable name for this type of job.
finish_code integer Whether or not the job succeeded. Will be 0 for success, and 1 for failure.
priority integer Controls which background_jobs records are processed first. The highest priority is 0, and the lowest is 100. Integer values in between are also valid.
title character varying Can be used to provide some additional information about the job.
created_on_worker character varying Identifies the machine that created this background_jobs record.
processed_on_worker character varying Identifies the machine on which the job is run.
link text Used, for certain types of jobs, to record a relevant URL.
lock_version integer Used to implement "optimistic locking." Don't set this or mess with it, it's all handled automatically.
backgrounder_id character varying Indicates which backgrounder process ran the job.
serial_collection_id integer It is possible to designate a job as part of a "serial collection," by setting its serial_collection_id. Two jobs with the same serial_collection_id cannot be processed simultaneously. Note that serial_collection_id is actually a foreign key to the serial_collections table. This is not a capability that sees much use.
site_id integer Links to a site, if one is relevant, otherwise it is left NULL.
subtitle character varying Can be used to provide some additional information about the job.
language character varying The language for the job is listed here.
locale character varying The locale for the job is listed here.
correlation_id integer The ID to correlate occurrences of the same job, which is the foreign key reference to the record in the respective definition table for subscriptions (subscriptions table) and extract-refresh jobs (tasks table).
attempts_remaining integer Used track amount of execution attempts remaining for the job. Usually NULL for job that are attempted only once. Number greater than 0 for jobs that will be retried.
big_texts: This table serves as a convenient place to store a big text object, if necessary. It's kind of a utility table. This table is really just used for internal purposes.
Name Type Description
id integer Primary key for this record.
txt text Holds whatever text object is desired. There is no specific designated use for this field. Any code can store a text object here for whatever purpose it wishes.
updated_at timestamp without time zone The time at which this record was last changed.
capabilities: Holds a relatively short list of capabilities. A user can be allowed certain capabilities either through being some sort of admin, or through owning something like a workbook or a project, or via entries in the next_gen_permissions table. Capabilities are things like read, write, export_data, publish, web_authoring, etc.
Name Type Description
id integer Primary key for the record.
name character varying This (or the id) is how the capability is referred to by code.
display_name character varying This is the name that may be displayed to a user.
display_order integer Ascending order of this value is the order in which capabilities are listed, when displayed.
capability_roles: This table serves primarily to associate roles with capabilities. A given role can have many capabilities, and a given capability can be associated with several roles.
Name Type Description
Foreign key/Primary key relation from capability_id on this table to id on table, capabilities
Foreign key/Primary key relation from role_id on this table to id on table, roles
id integer Primary key for this record.
capability_id integer Foreign key reference to the capabilities table.
role_id integer Foreign key reference to the roles table.
comments: Comments users made on views.
Name Type Description
Foreign key/Primary key relation from user_id on this table to id on table, users
id integer Primary key for this record.
title text Not used.
comment text Comment text.
created_at timestamp without time zone Date when comment was created.
commentable_id integer Corresponding view id.
commentable_type character varying View.
user_id integer Id of the user who made the comment.
drawing text Not used.
updated_at timestamp without time zone Date when comment was last updated.
customized_views: When a user creates a customized view, the data that supports that goes in this table.
Name Type Description
Foreign key/Primary key relation from start_view_id on this table to id on table, views
Foreign key/Primary key relation from view_id on this table to id on table, views
Foreign key/Primary key relation from site_id on this table to id on table, sites
Foreign key/Primary key relation from creator_id on this table to id on table, users
id integer Primary key for the record.
name character varying The name of the customized view.
description text A description of the customized view. Seems not to be used commonly.
view_id integer A foreign key reference to the views table. Refers specifically to the view that this customized view is based on.
created_at timestamp without time zone When this record was created.
updated_at timestamp without time zone When this record was last updated.
creator_id integer Foreign key reference to the user who created this customized view.
public boolean Indicates if the user elected to share his customized view.
size integer The number of bytes it took to describe the changes from the base view to the customized view.
site_id integer A foreign key to the site that this customized view is associated with (the site of the user who created it).
repository_data_id bigint A reference to an entry in the repository_data table, which, in turn references the PostgreSQL large object that contains the customization data, and whose size was mentioned above.
repository_thumbnail_data_id bigint A reference to an entry in the repository_data table, which, in turn references the PostgreSQL large object that contains the thumbnail image for this customized view.
url_id character varying A URL compatible string derived from the name of the customized view. This must be unique when taken together with the customized view creator and the view.
start_view_id integer A foreign key reference to the view from which this customized view was derived.
luid uuid A "locally unique" id used to identify this record for certain uses. It is generated automatically, and is nothing that a customer needs to worry about.
data_id character varying Unique ID used to identify the view data.
thumbnail_id character varying Unique ID used to identify the thumbnail.
data_alerts: Each record represents an alert. An alert is a predefined data conditions on a view, and if conditions are met all alert recipients get notified.
Name Type Description
Foreign key/Primary key relation from schedule_id on this table to id on table, schedules
Foreign key/Primary key relation from creator_id on this table to id on table, users
Foreign key/Primary key relation from view_id on this table to id on table, views
Foreign key/Primary key relation from workbook_id on this table to id on table, workbooks
Foreign key/Primary key relation from site_id on this table to id on table, sites
id integer Primary key for the record.
title character varying A string that describes the alert.
creator_id integer User id for user who created the alert. FK reference to users.id.
schedule_id integer A foreign key reference to the record in the schedules table that describes exactly when the alert will be triggered, and it can also be null for extract refresh based data.
last_triggered timestamp with time zone The last time at which the the alert was sent.
site_id integer Site ID for alert. FK reference to sites.id.
workbook_id integer A foreign key reference to the workbook.id.
view_id integer A foreign key reference to the view.id.
customized_view_id integer A foreign key reference to the customized.view.id.
luid uuid UUID for alert used in REST APIs.
data_condition character varying The comparison data for certain data condition types that will cause this alert to be sent out.
data_specification character varying Platform-parsable blob that describes which data to track.
data_alerts_recipients: Each record represents the intent of recipient to be notified if an event is triggered.
Name Type Description
Foreign key/Primary key relation from data_alert_id on this table to id on table, data_alerts
id integer Primary key for the record.
recipient_id integer It references a user or group id.
data_alert_id integer A reference to data alert id.
recipient_type character varying A string that describes the recipient type, currently single user or group.
data_connections: Describes various data sources that are included in either workbooks or datasources.
Name Type Description
Foreign key/Primary key relation from datasource_id on this table to id on table, datasources
Foreign key/Primary key relation from site_id on this table to id on table, sites
id integer Primary key for the record.
server text DNS server name to connect to.
dbclass character varying Type of data connection (ie mysql, postgres, sqlproxy etc).
port integer TCP port number of the connection (eg. 5432 for postgres).
username character varying Username to use when connecting.
password boolean True means password is embedded in owner (see owner_type and owner_id fields).
name character varying Unique identifier for this data_connection.
dbname character varying The database name to which the particular connection is linked.
tablename character varying The name of the table in the database that this connection connects to.
owner_type character varying One of "Datasource" or "Workbook". It is the type of object making the data connection.
owner_id integer The ID of the workbook or datasource that is creating the data connection.
created_at timestamp without time zone When this record was created.
updated_at timestamp without time zone When this record was last updated.
caption character varying Friendly name of this connection as seen in the Desktop data pane.
site_id integer A foreign key reference to the site in which this data connection is contained.
keychain text Encode string in yaml format. An attribute bag that will match the embedded keychain connection this connection is associated with.
luid uuid The locally unique ID, which is intended for exposing externally by the server API. This is automatically generated.
has_extract boolean Indicates if the data connection is an extract.
datasource_id integer Reference to the Datasource that owns this data connection.
db_subclass character varying Subclass of the dbclass, for example, dbclass is webdata-direct, db_subclass is intuit-quickbook
datasource_metrics_aggregations: Each record represents a partial aggregation of analytics for a given datasource in a given time interval. It is often necessary to sum across multiple rows to find a total for a given time interval.
Name Type Description
Foreign key/Primary key relation from datasource_id on this table to id on table, datasources
id integer Primary key for the record.
datasource_id integer A foreign key reference to the datasource.
day_index integer Records what day of the month the analytics are aggregated over. When NULL or 0, the aggregation is for the month and year as designated by month_index and year_index.
month_index integer Records what month of the year the analytics are aggregated over. When NULL or 0, the aggregation is for the year as designated by year_index.
year_index integer Records what year the analytics are aggregated over
view_count integer Records the number of times a datasource was viewed in the given time interval.
datasource_refresh_properties: Extension of datasources table for refresh properties (Online). This is 1-0/1 relationship to datasources table. It is a separate table since it contains Online-specific properties.
Name Type Description
Foreign key/Primary key relation from id on this table to id on table, datasources
Foreign key/Primary key relation from remote_agent_id on this table to id on table, remote_agents
id integer Datasource ID from datasources table. it is 1-0/1 relationship to datasources table.
refresh_mode character varying Specifies the mode of datasource refresh
remote_agent_id integer The associated remote agent ID responsible for data source refresh.
schedules json Array of DatasourceRefreshSchedule objects in JSON format.
last_refresh_error_client_data character varying Information about the last refresh error for the purpose of reconstructing the client view of the errors.
remote_agent_reservation_id character varying Unique string, e.g. GUID, that represents a reservation that a remote agent has yet to claim.
datasource_versions: Datasource versions saved on server.
Name Type Description
Foreign key/Primary key relation from datasource_id on this table to id on table, datasources
Foreign key/Primary key relation from site_id on this table to id on table, sites
id integer The id of a version. Primary key.
site_id integer Reference to entury in sites table. Indicates the site to which this datasource version belongs to.
datasource_id integer A foreign key to the datasources table. Reference to Datasource.
publisher_id integer Reference to user in site users table. User who published this version. Can point to deleted user.
version_number integer The version number.
published_at timestamp without time zone The time when this version was initially published. Copied from datasource record last_updated field at the time of being overwritten.
size bigint The size, in bytes, of this version of datasource.
content_key character varying Key of the datasource as string
sos_type character varying The SOS data type under which this version document is stored, or null if it is not stored in SOS.
datasources: Records all Published datasources on server.
Name Type Description
Foreign key/Primary key relation from owner_id on this table to id on table, users
Foreign key/Primary key relation from project_id on this table to id on table, projects
Foreign key/Primary key relation from site_id on this table to id on table, sites
Foreign key/Primary key relation from remote_query_agent_id on this table to id on table, remote_agents
id integer Primary key for the record.
name character varying The name of the published datasource.
repository_url text Uniquely identifies a datasource. More or less consists of a slightly modified name, but not totally obviously, especially in the presence of non-ASCII characters. Used in URLs meant to access this datasource.
owner_id integer The user ID of the owner/uploader of the datasource.
created_at timestamp without time zone When this record was created.
updated_at timestamp without time zone When this record was last updated.
project_id integer The associated project ID where the datasource was published.
size bigint The size in bytes of the datasource.
lock_version integer Used to implement "optimistic locking". Don't set this or mess with it, it's all handled automatically.
state character varying One of "active" or NULL.
db_class text The origin of the data. It's often a database, but the concept is a bit more general than that. For example, "oracle" and "db2" are possibilities, but so are "excel" and "dataengine" (and many more).
db_name text The name of the database associated with the published datasource. But because data sources are more general than databases, in some instances, this might actually be a file path, or blank.
table_name text The name of the table associated with the published datasource. But, because data sources are more general than databases, this might, for example, actually refer to an Excel worksheet, or be blank.
site_id integer A foreign key reference to the site with which this datasource is associated.
revision character varying Increments each time a new version of the datasource is published.
repository_data_id bigint A reference to an entry in the repository_data table, which, in turn references the PostgreSQL large object that contains the datasource tdsx contents. either this field or repository_extract_data_id should be non-NULL. Sometimes both could be non-NULL.
repository_extract_data_id bigint A reference to an entry in the repository_data table, which, in turn references the PostgreSQL large object that contains the datasource twbx contents minus any extract data. either this field or repository_data_id should be non-NULL. Sometimes both could be non-NULL.
embedded text An encrypted keychain holding any credentials stored with the datasource.
incrementable_extracts boolean True or false as to whether incrementable extracts are allowed for the published datasource.
refreshable_extracts boolean True or false as to whether refreshable extracts are avaliable for the published datasource.
data_engine_extracts boolean True means the data was supplied in the form of a Tableau data extract, though the original source of the data may be known to reside elsewhere.
extracts_refreshed_at timestamp without time zone Records the time of the last full extract refresh.
first_published_at timestamp without time zone When the first publication of this datasource occurred.
connectable boolean If this datasource was published using a release of the software where connecting to datasources through the Data Server was supported (post 7.0).
is_hierarchical boolean Set to true if the source is a hierarchical (cube) database.
extracts_incremented_at timestamp without time zone Records the time of the last incremental extract refresh.
luid uuid Unique identifier.
document_version character varying The internal version of the .tds file associated with this record.
description text A textual description of the datasource.
content_version integer $Version number of the datasource. updated on each publish
parent_workbook_id integer Is set to null for published datasources or else references the workbook id that contains this datasource.
hidden_name character varying Auto-generated name for the datasource extracted from the twb/tds file.
last_published_at timestamp without time zone Time that the user last published this datasource to server. For datasources that were last published before this column existed, the value will be null.
data_id character varying Unique ID used to identify the datasource data.
reduced_data_id character varying Unique ID used to identify the reduced datasource data.
remote_query_agent_id integer If present, the agent to remote queries to.
desktop_reporting: Missing description
Name Type Description
id integer Missing description
app_version character varying Tableau product version.
email character varying Registered email address.
expiration_date date Expiration date of active key. NULL means permanent.
first_name character varying First Name.
last_name character varying Last Name.
computer_user_id character varying Computer user or login id.
host_name character varying Computer host name.
department character varying Department.
company character varying Company or organisation.
os_version character varying OS version.
os_architecture character varying OS architecture.
registration_date timestamp without time zone Date active key was registered.
last_report_date timestamp without time zone Last report for this Desktop.
maintenance_expiration date Maintenance expiration of in use product key.
product_name character varying Product name.
edition character varying Tableau Desktop Edition. E.g Professional or Standard.
type character varying Type of key. Trial or Perpetual.
product_keys character varying Semicolon delimited product keys. Characters beyond 9 replaced with X.
serial_number character varying Computer serial number.
mac_address character varying Network card MAC address.
domain character varying Computer Active Directory domain.
unique_machine_number character varying Unique Machine Number. A string uniquely identifying a computer.
action character varying Action: Activate, Use or Return.
action_key character varying Key being used activated or returned.
domains: Records represent either an Active Directory domain or an authenticate system.
Name Type Description
id integer Primary key for the record
name character varying The name is either "local" or the name of some Active Directory group.
short_name character varying An alternate shorter form of the name
active boolean Indicates if the domain is active or not.
family character varying Either local or ActiveDirectory.
extract_sessions: Extracts that have active vizql sessions.
Name Type Description
id integer Primary key for this record.
extract_id integer Foreign key reference to the extracts table.
session_guid character varying Vizql session identifier.
session_type character varying One of "Workbook" or "Datasource"
created_at timestamp without time zone Date when extract session was created.
worker_name character varying Worker on which extract session was created.
extracts: Each record corresponds to a directory that contains one or more extract files associated with either a workbook or datasource.
Name Type Description
Foreign key/Primary key relation from datasource_id on this table to id on table, datasources
Foreign key/Primary key relation from workbook_id on this table to id on table, workbooks
id integer Primary key for this record.
workbook_id integer If the extracts are associated with a workbook, then this is a foreign key link to that workbook, otherwise it is NULL.
descriptor character varying The UUID that is the name of the directory where the extracts are saved.
created_at timestamp without time zone When this record was created.
updated_at timestamp without time zone When this record was last updated.
datasource_id integer If the extracts are associated with a datasource, then this is a foreign key link to that datasource, otherwise it is NULL.
group_users: Serves as a many to many linking mechanism between users and groups. A user can belong to multiple groups, and a group can contain multiple users.
Name Type Description
Foreign key/Primary key relation from group_id on this table to id on table, groups
Foreign key/Primary key relation from user_id on this table to id on table, users
id integer Primary key for this record.
group_id integer A foreign key reference to an entry in the groups table.
user_id integer A foreign key reference to an entry in the users table.
groups: A grouping of users. Can be locally created or imported from Active Directory.
Name Type Description
Foreign key/Primary key relation from domain_id on this table to id on table, domains
Foreign key/Primary key relation from site_id on this table to id on table, sites
id integer Primary key for this record.
name character varying The name that was given to the group.
created_at timestamp without time zone When this record was created.
updated_at timestamp without time zone When this record was last updated.
system boolean Indicates if this group was created by Tableau itself, or if it was created by user action.
owner_id integer A foreign key link to the user who owns this group.
domain_id integer A foreign key link to the domain that corresponds to this group.
site_id integer A foreign key link to the site to which this group belongs.
luid uuid An identifier that is unique in combination with the site_id.
minimum_site_role character varying The minimum site role given to members of the AD group
last_synchronized timestamp without time zone Last time that synchronization for an AD group was completed
hist_capabilities: Records the most useful information about a capability that was relevant at the time of the event (see capabilities table).
Name Type Description
id integer Primary key for the record.
capability_id integer A foreign key reference to an entry in the capabilities table. This could be NULL if the matching record in the capabilities table was deleted since this record was created.
name text This (or the id) is how the capability is referred to by code.
allow boolean Whether or not the capability is allowed.
hist_comments: Records the most useful information about a comment that was relevant at the time of the event (see comments table).
Name Type Description
id integer Primary key for this record.
comment_id integer A foreign key link to the primary key for the comments record. This could be NULL if the matching record in the comments table was deleted since this record was created.
comment text Comment text.
hist_configs: Can be used to record information about configuration that was in effect at the time of the historical event.
Name Type Description
id integer Primary key for this record.
key text A unique name for the specific configuration.
value text The value of the configuration.
hist_data_connections: Records the most useful information about a data connection that was relevant at the time of the event (see data_connections table).
Name Type Description
id integer Primary key for this record.
data_connection_id integer A foreign key reference to an entry in the data_connections table. This could be NULL if the matching record in the data_connections table was deleted since this record was created.
server text DNS server name to connect to.
name text Unique identifier for this data_connection.
dbname text The database name to which the particular connection is linked.
table_name text The name of the table in the database that this connection connects to.
hist_datasources: Records the most useful information about a data source that was relevant at the time of the event (see datasources table).
Name Type Description
id integer Primary key for this record.
datasource_id integer A foreign key reference to an entry in the datasources table. This could be NULL if the matching record in the datasources table was deleted since this record was created.
name text The name of the published datasource.
repository_url text Uniquely identifies a datasource. More or less consists of a slightly modified name, but not totally obviously, especially in the presence of non-ASCII characters. Used in URLs meant to access this datasource.
size bigint The size in bytes of the datasource.
revision text Increments each time a new version of the datasource is published.
hist_groups: Records the most useful information about a group that was relevant at the time of the event (see groups table).
Name Type Description
id integer Primary key for this record.
group_id integer A foreign key reference to an entry in the groups table. This could be NULL if the matching record in the groups table was deleted since this record was created.
name text The name that was given to the group.
domain_name text The name is either "local" or the name of some Active Directory group.
hist_licensing_roles: Records the most useful information about a licensing role that was relevant at the time of the event (see licensing_roles table).
Name Type Description
id integer Primary key for this record.
licensing_role_id integer A foreign key reference to an entry in the licensing_roles table. This could be NULL if the matching record in the licensing_roles table was deleted since this record was created.
name text The name of the licensing role.
hist_projects: Records the most useful information about a project that was relevant at the time of the event (see projects table).
Name Type Description
id integer Primary key for this record.
project_id integer A foreign key reference to an entry in the projects table. This could be NULL if the matching record in the projects table was deleted since this record was created.
name text The name of the project.
hist_schedules: Records the most useful information about a schedule that was relevant at the time of the event (see schedules table).
Name Type Description
Foreign key/Primary key relation from schedule_id on this table to id on table, schedules
id integer Primary key for this record.
schedule_id integer A foreign key reference to an entry in the schedules table. This could be NULL if the matching record in the schedules table was deleted since this record was created.
name text A schedule can be given a name, which is stored here.
schedule_type integer One of 0 (Hourly), 1 (Daily), 2 (Weekly), 3 (Monthly).
priority integer Priority can range from 1 to 100, with lower values corresponding to higher priority.
scheduled_action integer Used to classify schedules into one of two categories: 0 (Extract related) 1 (Subscription related)
is_serial boolean Set to true if the schedule must be run serially with other jobs in the same serial collection.
day_of_week_mask integer Indicates which day of the week this schedule will run. The information is encoded in the given integer. To interpret it, convert the integer to binary. The days of the week correspond to Sunday : 1, Monday : 10, Tuesday : 100, Wednesday : 1000, Thursday : 10000, Friday : 100000, Saturday : 1000000.
day_of_month_mask integer Indicates which day of the month this schedule will run. The information is encoded in the given integer. To interpret it, convert the integer to binary. The days of the month correspond to 1st : 1, 2nd: 10, 3rd: 100, 4th: 1000, 5th: 10000, etc.
start_at_minute integer The minute following the start of the designated time period implied by the schedule_type. For example, for a daily schedule, this would be number of minutes past midnight at the start of the day. For hourly, it would be the number of minutes past the beginning of the hour.
minute_interval integer Once the schedule triggers, it will retrigger at this interval during the time period implied by the schedule_type or until end_at_minute, or end_schedule_at.
end_at_minute integer The minute following the start of the designated time period implied schedule_type, at which the schedule should stop triggering.
end_schedule_at timestamp without time zone Used to indicate a point in time, after which the schedule should never trigger.
hist_sites: Records the most useful information about a site that was relevant at the time of the event (see sites table).
Name Type Description
id integer Primary key for this record.
site_id integer A foreign key reference to an entry in the sites table. This could be NULL if the matching record in the sites table was deleted since this record was created.
name text The name of the site.
url_namespace text String used in the construction of URLs that target this site.
hist_tags: Records the most useful information about a tag that was relevant at the time of the event (see tags table).
Name Type Description
id integer Primary key for this record.
tag_id integer A foreign key reference to an entry in the tags table. This could be NULL if the matching record in the tags table was deleted since this record was created.
name text The value of the tag.
hist_tasks: Records the most useful information about a task that was relevant at the time of the event (see tasks table).
Name Type Description
id integer Primary key for this record.
task_id integer A foreign key reference to an entry in the tasks table. This could be NULL if the matching record in the tasks table was deleted since this record was created.
type text Identifies the specific type of task that this is. This is how the system identifies what code to execute when this task is to be run.
priority integer An integer where 0 is the highest priority and 10 is the default priority. Other values can be set if desired). Higher priority jobs should be processed earlier.
hist_users: Records the most useful information about a user and corresponding system_user that was relevant at the time of the event (see users and system_users tables).
Name Type Description
Foreign key/Primary key relation from hist_licensing_role_id on this table to id on table, hist_licensing_roles
id integer Primary key for this record.
user_id integer A foreign key reference to an entry in the users table. This could be NULL if the matching record in the users table was deleted since this record was created.
name text The username of the user.
domain_name text The name is either "local" or the name of some Active Directory group.
email text The email of the user.
system_user_id integer A foreign key reference to the system user that this user is identified with. This could be NULL if the matching record in the system_users table was deleted since this record was created.
system_admin_level integer Indicates if the user is a system administrator. 10 : system admin, 0 : not a system admin
hist_licensing_role_id integer A foreign key reference to the licensing_role_id column for a record in the hist_licensing_roles table.
site_admin_level integer Indicates if this user is a site admin. 5 : site admin, 0 : not site admin.
publisher_tristate integer From among 0 (not), 1 (implicit) and 2 (explicit).
hist_views: Records the most useful information about a view that was relevant at the time of the event (see views table).
Name Type Description
id integer Primary key for this record.
view_id integer A foreign key reference to an entry in the views table. This could be NULL if the matching record in the views table was deleted since this record was created.
name text The name of the view.
repository_url text Uniquely identifies a view. More or less composed of workbook and sheet names, but not totally obviously, especially in the presence of non-ASCII characters. Used in URLs meant to access this view.
revision text Starts with 1.0 and increments by 0.1 with each republication.
hist_workbooks: Records the most useful information about a workbook that was relevant at the time of the event (see workbooks table).
Name Type Description
id integer Primary key for this record.
workbook_id integer A foreign key reference to an entry in the workbooks table. This could be NULL if the matching record in the workbooks table was deleted since this record was created.
name text The name of the workbook.
repository_url text A unique name for the workbook, derived from the ASCII characters in the name, which can be used in URLs to refer to this workbook.
size bigint The number of bytes used in storing the workbook information.
revision text Starts with 1.0 and increments by 0.1 with each republication.
historical_disk_usage: Records historical disk utilization by Tableau Server for storage monitoring.
Name Type Description
id integer Primary key for this record.
worker_id character varying Hostname of the worker the resource exists on.
resource_type integer Type of resource being monitored. 0 (Entire disk).
path character varying Disk path of the monitored resource.
total_space_bytes bigint Total disk size in bytes.
used_space_bytes bigint Disk space used by the resource in bytes.
state integer Free space state of the disk. One of 1 (Normal), 2 (Warning), 3 (Critical).
record_timestamp timestamp without time zone The time at which this record was created.
historical_event_types: The types of historical events which can be recorded.
Name Type Description
type_id integer Primary key for this record.
name text The name of the specific event that occurred.
action_type text Events are grouped together into action types, such as Create, Access, Update and Delete.
historical_events: This table is the heart of the cluster of tables devoted to historical event auditing. For each event, a record is created on this table. The type of event is indicated through historical_event_type_id, which links to the historical_event_types table. Other information relevant to the event is linked through some of the other id fields in this table. Note these links go to other hist* tables, which allows the event to refer to things that might have since been deleted from the regular tables.
Name Type Description
Foreign key/Primary key relation from historical_event_type_id on this table to type_id on table, historical_event_types
id integer Primary key for this record.
historical_event_type_id integer A foreign key reference to an entry in the historical_event_types table.
worker text The name or IP address of the worker where the event occurred.
is_failure boolean Indicates if the event was an attempted action that failed. May not be implemented across all events.
details text Detail text about the event.
created_at timestamp without time zone Datetime that the event was recorded.
hist_actor_user_id integer A reference to the primary key id column for the record in the hist_users table of the user who initiated the event.
hist_target_user_id integer A reference to the primary key id column for the record in the hist_users table of the user who was the target of the event.
hist_actor_site_id integer A reference to the primary key id column for the record in the hist_sites table where the event was initiated.
hist_target_site_id integer A reference to the primary key id column for the record in the hist_sites table which was the target of the event.
hist_project_id integer A reference to the primary key id column for a record in the hist_projects table.
hist_workbook_id integer A reference to the primary key id column for a record in the hist_workbooks table.
hist_view_id integer A reference to the primary key id column for a record in the hist_views table.
hist_datasource_id integer A reference to the primary key id column for a record in the hist_datasources table.
hist_comment_id integer A reference to the primary key id column for a record in the hist_comments table.
hist_tag_id integer A reference to the primary key id column for a record in the hist_tags table.
hist_group_id integer A reference to the primary key id column for a record in the hist_groups table.
hist_licensing_role_id integer A reference to the primary key id column for a record in the hist_licensing_roles table.
hist_schedule_id integer A reference to the primary key id column for a record in the hist_schedules table.
hist_task_id integer A reference to the primary key id column for a record in the hist_tasks table.
hist_data_connection_id integer A reference to the primary key id column for a record in the hist_data_connections table.
hist_config_id integer A foreign key reference to the config_id column for a record in the hist_configs table.
hist_capability_id integer A reference to the primary key id column for a record in the hist_capabilities table.
http_requests: Each record represents a request received by Tableau Server.
Name Type Description
id integer Primary key for this table.
controller character varying The part of the application that received the request.
action character varying The action requested.
http_referer character varying The referrer.
http_user_agent character varying The agent string supplied by the client.
http_request_uri text The requested URI.
remote_ip character varying The client's IP address (from the perspective of the server).
created_at timestamp without time zone When this record was created.
session_id character varying The session with which the request is associated.
completed_at timestamp without time zone When the request was completed.
port integer The port on which the request was received.
user_id integer The user associated with the request.
worker character varying Which worker machine received the request.
status integer The status returned to the client.
user_cookie character varying The user cookie provided in the request.
user_ip character varying The IP address of the originator of the request.
vizql_session text The vizql session associated with this request.
site_id integer The site associated with the request.
currentsheet character varying Which sheet was being viewed.
language_prefs: Contains a listing of information about languages for which Tableau Server has been localized.
Name Type Description
language_id character varying A unique ASCII string identifier for the language.
display_name character varying The name of the language (in the language, itself).
display_order integer Governs the order in which these languages will appear when listed in the user interface.
help_link text Used in constructing help links, so that help can be presented in the appropriate language.
locale_id character varying A unique identifying string that corresponds to a locale with this language.
licensing_roles: Lists the various possible licensing scenarios. (Unlicensed, Guest, Viewer, or Interactor).
Name Type Description
id integer Primary key for the record.
name character varying The name of the licensing role.
rank integer Used to provide an order of increasing rights.
local_names: Contains translations of certain words or phrases that are relevant to some Tableau Server database constructs.
Name Type Description
id integer Primary key for the record.
language_id character varying Abbreviation for a particular language.
obj_name character varying A string that uniquly represents the object to be translated. This name, by convention, is very similar, if not identical to the name field for English.
obj_type character varying The type of the object. For example, "Project" or "Site".
name character varying How to call this object in the specified language, as given by language_id.
mobile_enrollments: Keeps track of most recent time a user has been enrolled for a mobile device. User will typically be enrolled onto server by logging into server through the mobile client. A user may be enrolled under multiple devices if the devices have different attributes (pixel width, pixel height, pixel ratio)
Name Type Description
Foreign key/Primary key relation from user_id on this table to id on table, users
id integer Primary key for the record.
user_id integer A foreign key reference to the user who is enrolled.
width integer The port size (width) of the device that is enrolled.
height integer The port size (height) of the device that is enrolled.
pixel_ratio real Used to distinguish high dpi of the enrolled devices.
last_enrolled_at timestamp without time zone The most recent time a user has been enrolled for a mobile device.
most_recent_refreshes: most recent refresh data for alerts
Name Type Description
id integer Missing description
historical_event_type_id integer historical event type of the refresh
worker text worker executing refresh
duration_in_ms integer duration of refresh
details text details of refresh
task_id integer task id
site_id integer site id
data_connection_id integer data connection id
is_failure boolean whether or not refresh failed
created_at timestamp without time zone when refresh occurred
workbook_id integer workbook being refreshed
datasource_id integer datasource being refreshed
mru_list_entries: Holds most recently used list entries. The records here are linked to the lists to which they belong. Those lists are defined in the mru_lists table.
Name Type Description
Foreign key/Primary key relation from mru_list_id on this table to id on table, mru_lists
id integer Primary key for the record.
mru_list_id integer A foreign key reference to the mru_list record to which this item belongs.
useable_id integer A kind of "polymorphic" foreign key reference. It contains the id of the item to which this entry refers. Look for it in the table indicated by the useable_type field.
useable_type character varying One of "User" "View" "Project" "Workbook" or "Tag". Indicates the type of item that this is.
position integer When the items are shown in order, this field defines that order.
used_at timestamp without time zone The last time at which the item referred to by this entry was accessed.
usedobj_name text The name of the item referred to by this entry.
usedobj_url text A URL-like identifier for the item referred to by this entry.
mru_lists: Most recently used lists by user. The actual list contents are in the mru_list_entries table.
Name Type Description
Foreign key/Primary key relation from user_id on this table to id on table, users
id integer Primary key for the record.
user_id integer A foreign key reference to the user who is associated with this list.
list_type character varying One of "users" "views" "projects" "workbooks" or "tags".
next_gen_permissions: This table provides a flexible means of describing which users and groups have been granted which capabilities, on which things. Be aware that permissions is a complex topic and that this table does not contain all relevant information about permissions. For example, some permissions are given, automatically, to owners of workbooks or projects.
Name Type Description
Foreign key/Primary key relation from capability_id on this table to id on table, capabilities
id integer Primary key for the record.
authorizable_type character varying Describes the type of thing for which permissions are being specified. Must be one of "Project" "Workbook" "Datasource" "View" or "NamedResource".
authorizable_id integer The id value of the thing for which permissions are being specified. So, for example, if authorizable_type were "Workbook" then authorizable_id would correspond to the id value of the workbook in question.
grantee_id integer Refers to either the id of the "users" table or the id of the "groups" table depending on the value of grantee_type.
grantee_type character varying Permissions can be assigned to either users or groups, and this tells you which. Entry must be one of "User" or "Group".
capability_id integer Indicates which capability is to be granted or denied by this record. It is a foreign key link to the capabilities table where the corresponding record describes the nature of the capability in question.
permission integer An integer from 1 to 4 that combines whether the permission is applied to a user or to a group (which can also be seen from grantee_type) as well as whether this is granting or denying the capability. The meaning of the values is: 1: grant to group, 2: deny to group, 3: grant to user, 4: deny to user. Ascending order corresponds to increasing precedence. For example, a capability denied to a group (2) can be overriden by the same capability granted specifically to a user in that group (3).
oauth_request_tokens: Missing description
Name Type Description
id integer Primary key for the record.
entry_db_class character varying The connection class of the connection to which the token will belong.
entry_db_subclass character varying The connection subclass of the connection to which the token will belong
request_token text The request token which can be exchanged for an access token along with the request token secret.
request_token_secret_encrypted text The encrypted request token secret which can be exchanged for an access token along with the request token
is_used boolean Whether or not the request token/request token secret were exchanged for an access token or not.
created_at timestamp without time zone The time the record was created.
updated_at timestamp without time zone The time the record was last updated.
asset_key_id integer ID of key used to encrypt the token secret.
password_tokens: Tokens issued to client through link in email which can be redeemed to change their password
Name Type Description
Foreign key/Primary key relation from system_user_id on this table to id on table, system_users
id integer Primary key identifier for row
guid uuid Unique identifier for token
salt character varying The salt is used to hash the password
hashed_secret character varying Secret portion of token thats been hashed
expires_at timestamp without time zone When the token becomes expired
system_user_id integer Reference to system user that requested the token
permission_reasons: When calculating effective permissions in the perm_users_*_capabilities functions, this table maps the integer precedence of the effective permission rule to the varchar effective permission reason. The integer precedence is internal to the stored procedures. The effective permission reason is returned to callers.
Name Type Description
precedence integer The integer precedence of an effective permission rule. Higher value means higher precedence. Used in the perm_users_*_capabilities functions.
reason character varying The external identifier for an effective permission rule. Returned by the perm_users_*_capabilities functions.
permissions_templates: This table provides a flexible means of describing which users and groups will be granted which capabilities by default, on non-overwrite publishes of workbooks and datasources. Be aware that permissions is a complex topic and that this table does not contain all relevant information about permissions. For example, some permissions are given, automatically, to owners of workbooks or projects.
Name Type Description
Foreign key/Primary key relation from capability_id on this table to id on table, capabilities
Foreign key/Primary key relation from project_id on this table to id on table, projects
id integer Primary key for the record.
project_id integer Identifies the project for which this permission template applies.
template_type character varying Determines whether the permission template applies to workbooks or datasource. Value must be "Workbook" or "Datasource".
grantee_id integer Refers to either the id of the "users" table or the id of the "groups" table depending on the value of grantee_type.
grantee_type character varying Permissions can be assigned to either users or groups, and this tells you which. Entry must be one of "User" or "Group".
capability_id integer Indicates which capability is to be granted or denied by this record. It is a foreign key link to the capabilities table where the corresponding record describes the nature of the capability in question.
permission integer An integer from 1 to 4 that combines whether the permission is applied to a user or to a group (which can also be seen from grantee_type) as well as whether this is granting or denying the capability. The meaning of the values is: 1: grant to group, 2: deny to group, 3: grant to user, 4: deny to user. Ascending order corresponds to increasing precedence. For example, a capability denied to a group (2) can be overridden by the same capability granted specifically to a user in that group (3).
projects: Each row of the table corresponds to a project on Tableau Server.
Name Type Description
Foreign key/Primary key relation from owner_id on this table to id on table, users
Foreign key/Primary key relation from site_id on this table to id on table, sites
id integer Primary key for the record.
name character varying The name of the project.
owner_id integer The id of the user who owns this project.
created_at timestamp without time zone The time at which this record was created.
updated_at timestamp without time zone The time at which this record was last changed.
state character varying If this is anything other than "active" then the project is inactive.
description text A textual description of the project.
site_id integer The site which contains this project.
special integer Has a value of 1 if this is a special system-created project (like the default project). Otherwise it is NULL.
luid uuid The locally unique ID, which is intended for exposing externally by the server API. This is automatically generated.
controlled_permissions_enabled boolean Indicates whether permissions on workbooks, views, and data sources are controlled at the project level.
refresh_token_devices: Devices that have been issued at least one refresh token
Name Type Description
id integer Primary key identifier
device_id character varying Unique identifier of the device. Must be unique across all instances of the same installations of client applications. This is expected to stay the same through the lifetime of the application.
device_name character varying Friendly name of the device to be displayed
system_user_id integer Reference to the system user the token is issued to
last_used_at timestamp without time zone Missing description
refresh_tokens: Tokens issued to clients which can be redeemed by the client for access to the server
Name Type Description
Foreign key/Primary key relation from refresh_token_device_id on this table to id on table, refresh_token_devices
id integer Primary key identifier
guid uuid Unique identifer of the refresh token
client_id character varying Unique identifier with which to associate to the refresh token series.
client_name character varying This column is no longer used and will be deleted once it will no longer be breaking an upgrade scenario
system_user_id integer Reference to the system user the token is issued to
expires_at timestamp without time zone When this token becomes expired. null means that it does not have absolute expiration time
last_used_at timestamp without time zone When the token was last redeemed for an access token
issued_at timestamp without time zone When this token was issued to the client
salt character varying The salt used when hashing the secret
hashed_secret character varying Secret portion of the token thats been hashed
session_id character varying The most current session that has been redeemed using this refresh token. Null if no sessions have been redeemed
refresh_token_device_id integer Reference to the device the token is issued to
next_hashed_secret character varying Secret portion of the token thats been hashed for the next refresh token
next_salt character varying The salt used when hashing the secret for the next refresh_token
remote_agents: Registry of remote agents (Online). Remote agents are programs installed on customer PC and executing tasks on a behalf of a customer. The first example of agent is Tableau Data Sync. It is running in background on customer desktop and performing automatic data source refreshes based on schedules defined by customers.
Name Type Description
Foreign key/Primary key relation from site_id on this table to id on table, sites
Foreign key/Primary key relation from owner_id on this table to id on table, users
id integer Primary key for the record.
owner_id integer Foreign key reference to the user who owns this project.
site_id integer Foreign key reference to the site which contains this remote agent.
name character varying Name of the remote agent. Usually agent computer name. This name must be unique for a specific site/user. Different users can have same agent (for example of shared computer).
time_zone_id character varying String identifier of agent's time zone. Time zone is specified during registration and can be changed later. Time zone ID is full name such as "America/Los_Angeles". It should be accepted by Java method java.util.TimeZone.getTimeZone(java.lang.String).
schedules_synced_at timestamp without time zone UTC time of last agent synchronization of schedules with the server. Time is the recorded server time.
device_id character varying ID generated by client and also given to the Refresh Token Service. Otherwise, one is randomly generated.
repository_data: This table forms the link between other tables that need to store "large object" data, and the large object storage, itself, which is in the pg_largeobject system table.
Name Type Description
id bigint Primary key for the record.
name text A possibly useful string that is mostly here to make it easier to debug.
content oid An oid field that references the corresponding data stored in the pg_largeobject table.
created_at timestamp without time zone The time at which this record was created.
tracking_id character varying Unique ID used to track the repository data.
type character varying Simple Object Storage type.
kind character varying Kind of data in content; file or folder.
roles: This table contains records corresponding to various classifications of users. It should really be viewed in conjuction with the capabilities and capability_roles tables. Taken together, these tables associate different roles with different sets of capabilities. The capabilities sets serve as templates when creating content.
Name Type Description
id integer Primary key for the record.
name character varying Each role has a name by which it is known to program code. Examples include, viewer, editor, interactor, ds_editor, etc.
created_at timestamp without time zone The time at which this record was created.
updated_at timestamp without time zone The time at which this record was last changed.
creator_id integer Links to the user who created this record, or is NULL. Not a significant value.
displayable boolean Used to distinguish between records that can be displayed in the GUI and those that cannot.
administrative boolean Roles are categorized as administrative in nature, or not. This field is used for filtering.
display_order integer Ascending order of this value is the order in which roles are listed, when displayed.
display_name character varying This is the name for the role, which will be displayed to the user.
schedules: Records in this table define a schedule according to which certain regular tasks may be performed (see tasks table). They also indicate the next time at which the schedule will be triggered.
Name Type Description
id integer Primary key for the record.
name character varying A schedule can be given a name, which is stored here.
active boolean If set to false, this means that the schedule is inactive, meaning that no tasks will be performed when the schedules triggers.
priority integer Priority can range from 1 to 100, with lower values corresponding to higher priority.
schedule_type integer One of 0 (Hourly), 1 (Daily), 2 (Weekly), 3 (Monthly).
day_of_week_mask integer Indicates which day of the week this schedule will run. The information is encoded in the given integer. To interpret it, convert the integer to binary. The days of the week correspond to Sunday : 1, Monday : 10, Tuesday : 100, Wednesday : 1000, Thursday : 10000, Friday : 100000, Saturday : 1000000.
day_of_month_mask integer Indicates which day of the month this schedule will run. The information is encoded in the given integer. To interpret it, convert the integer to binary. The days of the month correspond to 1st : 1, 2nd: 10, 3rd: 100, 4th: 1000, 5th: 10000, etc.
start_at_minute integer The minute following the start of the designated time period implied by the schedule_type. For example, for a daily schedule, this would be number of minutes past midnight at the start of the day. For hourly, it would be the number of minutes past the beginning of the hour.
minute_interval integer Once the schedule triggers, it will retrigger at this interval during the time period implied by the schedule_type or until end_at_minute, or end_schedule_at.
end_at_minute integer The minute following the start of the designated time period implied schedule_type, at which the schedule should stop triggering.
end_schedule_at timestamp without time zone Used to indicate a point in time, after which the schedule should never trigger.
run_next_at timestamp without time zone When the schedule will next trigger.
created_at timestamp without time zone The time at which this record was created.
updated_at timestamp without time zone The last time any changes were made to this record.
hidden boolean If set to true, then this schedule will not be listed in the GUI, otherwise it will be.
serial_collection_id integer A foreign key to the serial_collections table. Two jobs with the same serial_collection_id cannot be processed simultaneously. When the job record for a task linked to this schedule is created, it is assigned this serial_collection_id.
lock_version integer Used to implement "optimistic locking" by JPA/Hibernate. The counter increases each time the record is changed. Not useful for customers.
scheduled_action integer Used to classify schedules into one of two categories: 0 (Extract related) 1 (Subscription related)
luid uuid uuid for schedules used in the REST API
defined_by integer The mechanism type of how the schedule is created, e.g. 0 for system_admin, 1 for self_service.
schema_migrations: This table tracks which database migrations have been applied to this database.
Name Type Description
version character varying A string, derived from the name of the migration file, which serves to identify a particular migration that has been applied.
serial_collections: Records in this table represent groups of background jobs that should not be run simultaneously.
Name Type Description
id integer The primary key for the record.
description character varying Whoever creates the serial collection can decide what they want this description to say.
created_at timestamp without time zone The time at which this record was created
updated_at timestamp without time zone The last time any changes were made to this record.
sessions: Settings associated with a user's browser session.
Name Type Description
id integer The primary key for the record.
session_id character varying Session identifier.
data text Serialized session data.
updated_at timestamp without time zone Time when session was last updated, used to expire inactive sessions.
user_id integer Foreign key to users table
shared_wg_write text Settings used by wgserver (language/country preference etc).
shared_vizql_write text Settings used by vizql server.
site_id integer A foreign key to the sites table. Indicates the site to which this session belongs.
created_at timestamp without time zone A timestamp without timezone indicating how long ago the session was created
lock_version integer Used to implement "optimistic locking." Don't set this or mess with it, it's all handled automatically.
salt character varying The salt used when hashing the secret.
hashed_secret character varying Secret portion of the token thats been hashed.
sheet_images: Serves as a cache for all the sheet images generated by server.
Name Type Description
Foreign key/Primary key relation from customized_view_id on this table to id on table, customized_views
Foreign key/Primary key relation from view_id on this table to id on table, views
Foreign key/Primary key relation from generated_as_user_id on this table to id on table, users
id integer Primary key for the record.
width integer The port size (width) used to generate the image.
height integer The port size (height) used to generate the image.
pixel_ratio real The pixel ratio used to generate the image.
view_id integer A foreign key reference to the view used to generate the image.
language_id character varying A code indicating the language used to generate the image.
locale_id character varying A code indicating the locale used to generate the image.
generated_at timestamp without time zone A timestamp indicating when the image was generated.
data_storage_id bigint A reference to an entry in the repository_data table, which, in turn references the PostgreSQL large object that contains the sheet image for this entry.
generated_as_user_id integer A foreign key reference to the user the image was generated as. Can be null if the image was not generated as any user in particular.
customized_view_id integer A foreign key reference to the customized view that the image was generated as. Can be null if the image was not generated with a customized view.
cropped_height integer Indicates how many pixels were vertically cropped off of the generated image.
cropped_width integer Indicates how many pixels were horizontally cropped off of the generated image.
freshness_verified_at timestamp without time zone This date represents a point in time at which this sheet image is considered to be fresh.
data_id character varying Unique ID used to identify the image.
site_logos: custom logo image metadata for sites
Name Type Description
Foreign key/Primary key relation from site_id on this table to id on table, sites
id integer Missing description
site_id bigint the site the logo belongs to
width integer the image width in px
height integer the image height in px
storage_id character varying identifies the logo image on the storage back_end
url text the public URL of the logo
mime_type character varying the MIME type of the logo
created_at timestamp without time zone Missing description
updated_at timestamp without time zone Missing description
site_oidc_configurations: Defines the OpenID Connect IdP associated with a site.
Name Type Description
site_luid uuid Primary key for this table, matches the site.site_luid column.
is_enabled boolean Defines if the configration is active.
known_provider_alias text Name of the preconfigured provider, which must be defined in SiteSAML application.yml file.
client_id text OAuth2 client ID if using a custom provider.
client_secret text OAuth2 client secret if using a custom provider.
user_authorization_uri text OAuth2 user authorization URI if using a custom provider.
access_token_uri text OAuth2 access token URI if using a custom provider.
user_info_uri text OAuth2 user info URI if using a custom provider.
site_saml_configurations: Defines the SAML IdP associated with a site.
Name Type Description
Foreign key/Primary key relation from site_luid on this table to luid on table, sites
site_luid uuid Primary key for this table, matches the site.site_luid column.
idp_entity_descriptor text XML block of the EntityDescriptor for the Identity Provider.
attribute_mapping text Defines mapping for the saml response fields.
sp_certificate text PEM encoded certificate.
sp_private_key text PEM encoded private key.
is_enabled boolean Defines if the configration is active.
entity_descriptor_validation_result text JSON Serialized validation result.
authentication_domain_id character varying Authentication Domain.
authentication_type_for_embedded character varying Authentication type: DEFAULT or SAML.
allow_embedded_authentication boolean Flag if the site permits the authentication flow to be hosted in an iframe.
site_saml_events: Log table for all SAML actions.
Name Type Description
Foreign key/Primary key relation from site_luid on this table to luid on table, sites
id uuid Primary key for this table.
timestamp timestamp without time zone Timestamp for the event.
log_level character varying String value of the logging level.
message text Text of the logged message.
site_luid uuid Matches the site.site_luid column and site_saml_configurations.site_luid.
site_saml_sessions: Records the user sessions authenticated by the SiteSAML service.
Name Type Description
id character varying Primary key for this table.
site_luid uuid Matches the site.site_luid column and site_saml_configurations.site_luid.
last_accessed_at timestamp without time zone Timestamp for the last_accessed_at time of the seesion.
http_session bytea HTTP Session representation.
version bigint Version value if set.
site_saml_users: Users that are allowed to use Per Site SAML authentication.
Name Type Description
Foreign key/Primary key relation from site_luid on this table to luid on table, sites
id uuid Primary key for this table.
site_luid uuid Matches the site.site_luid column and site_saml_configurations.site_luid.
user_name character varying User name field.
auth_user_id character varying Matches the auth_user_id of the user stored in the system_users table.
authentication_type character varying Which type of authentication to use, e.g. SAML or OIDC.
site_user_prefs: Site user preferences.
Name Type Description
Foreign key/Primary key relation from user_id on this table to id on table, users
id integer The id of a site user preference. Primary key.
user_id integer A foreign key to users table. Indicates the site user to which this preference belongs.
refresh_failure_notification_enabled boolean Whether to send notification on failed extracts for this site user.
sites: Each record represents a site. Each site holds its own workbooks, datasources, users, etc. Strict isolation between the contents of each site is maintained.
Name Type Description
id integer Primary key for the record.
name character varying The name of the site.
url_namespace character varying String used in the construction of URLs that target this site.
status character varying One of "active" "suspended" or "locked".
created_at timestamp without time zone The time at which this record was created.
updated_at timestamp without time zone The last time any changes were made to this record.
content_admin_mode integer One of 1 (content only) or 2 (content and users).
storage_quota bigint Maximum storage for the site in megabytes.
status_reason character varying Holds an explanation for why a site is in a "suspended" status.
subscriptions_enabled boolean True if subscriptions are allowed for this site, otherwise false.
custom_subscription_footer text Content to be placed as the footer in each subscription email sent.
custom_subscription_email text The email from which to send subscriptions.
luid uuid An identifier which is unique to this site.
authoring_disabled boolean If true, then web authoring is disabled.
sheet_image_enabled boolean True if sheet image API is enabled for this site, otherwise false.
livedb_connections_whitelist_enabled boolean Missing description
refresh_token_setting integer Missing description
version_history_enabled boolean Setting for enabling/disabling version history on a site
notification_enabled boolean Setting for enabling/disabling system notification such as email notification on a site
content_version_limit integer Maximum number of versions to retain for each content type : workbooks ,datasources
subscribe_others_enabled boolean Setting for enabling/disabling the subscribe others functionality on a site
lock_version integer Used to implement "optimistic locking." Don't set this or mess with it, it's all handled automatically.
guest_access_enabled boolean Setting for enabling/disabling guest account per site
support_access_enabled boolean Setting for enabling/disabling access to a Tableau Online site by a Tableau support user
subscriptions: Each record represents a subscription.
Name Type Description
Foreign key/Primary key relation from schedule_id on this table to id on table, schedules
Foreign key/Primary key relation from creator_id on this table to id on table, users
Foreign key/Primary key relation from site_id on this table to id on table, sites
Foreign key/Primary key relation from user_id on this table to id on table, users
id integer Primary key for the record.
subject character varying A string that describes the nature of the subscription.
user_id integer A foreign key reference to the user who will receive the subscription.
schedule_id integer A foreign key reference to the record in the schedules table that describes exactly when the subscription will be triggered.
last_sent timestamp without time zone The last time at which the the subscription was sent.
site_id integer Site ID for Subscriptions. FK reference to sites.id
luid uuid UUID for subscriptions used in REST APIs
creator_id integer User id for user who created the subscription. FK reference to users.id
data_condition_type character varying The type of data condition that will cause this subscription to be sent out. Defaults to "Always", but can also be "DataPresent", "Constant", "Band", etc.
data_condition character varying The comparison data for certain data condition types that will cause this subscription to be sent out.
is_refresh_extract_triggered boolean Whether or not subscription is triggered by refresh extract
data_specification character varying JSON/XML blob that describes which data to track.
subscriptions_customized_views: This table is used to link various customized views to the subscriptions in which those customized views must be generated and emailed.
Name Type Description
Foreign key/Primary key relation from subscription_id on this table to id on table, subscriptions
Foreign key/Primary key relation from customized_view_id on this table to id on table, customized_views
id integer Primary key for the record.
subscription_id integer A foreign key reference to a record in the subscriptions table. Emailing the customized view referenced by the customized_view_id is one of the activities of the linked subscription.
customized_view_id integer A foreign key reference to a particular customized view.
subscriptions_views: This table is used to link various views to the subscriptions in which those views must be generated and emailed.
Name Type Description
Foreign key/Primary key relation from subscription_id on this table to id on table, subscriptions
id integer Primary key for the record.
subscription_id integer A foreign key reference to a record in the subscriptions table. Emailing the view referenced by the repository_url is one of the activities of the linked subscription.
repository_url text Used as a means to reference the particular view that is to be included in the subscription.
subscriptions_workbooks: This table is used to link various workbooks to the subscriptions in which those workbooks must have views generated and emailed.
Name Type Description
Foreign key/Primary key relation from site_id on this table to id on table, sites
Foreign key/Primary key relation from subscription_id on this table to id on table, subscriptions
id integer Primary key for the record.
subscription_id integer A foreign key reference to a record in the subscriptions table. Emailing the views of the workbook referenced by the repository_url is one of the activities of the linked subscription.
repository_url text Used as a means to reference the particular workbook that is to be included in the subscription.
site_id integer A foreign key reference to the site that the workbooked referred to by repository_url belongs.
system_users: Each record represents a user of the server. These records correspond to login identity. A single system_user may potentially be able to login to multiple sites. The linkage between a system_user and their allowed sites is defined through the "users" table.
Name Type Description
Foreign key/Primary key relation from domain_id on this table to id on table, domains
id integer Primary key for the record.
name character varying The username of the user.
email character varying The email of the user.
hashed_password character varying Hashed password - only used for local authentication.
salt character varying The salt used when hashing the password - only used for local authentication.
keychain text The encyrpted keychain for the user.
domain_id integer The domain for this user.
friendly_name character varying A friendly name that might be used in the GUI to refer to the user.
custom_display_name boolean If set to true, this prevents the friendly_name from potentially being overwritten by Active Airectory information when the user is read in from Active Directory. Seldom done.
admin_level integer Indicates if the user is a system administrator. 10 : system admin, 0 : not a system admin
created_at timestamp without time zone The time at which this record was created.
updated_at timestamp without time zone The last time any changes were made to this record.
auth_user_id character varying An external, immutable identifier for the user provided by an external authorization system.
asset_key_id integer The id for the asset encryption key used to encrypt the keychain for this user.
lock_version integer Used to implement "optimistic locking." Don't set this or mess with it, it's all handled automatically.
taggings: Associates tags with taggable items.
Name Type Description
Foreign key/Primary key relation from tag_id on this table to id on table, tags
Foreign key/Primary key relation from user_id on this table to id on table, users
id integer The primary key for the table.
tag_id integer The ID of the tag.
taggable_id integer The ID of the taggable item.
taggable_type character varying The type of the taggable item - this is used to identify which table to join to.
user_id integer The ID of the owning user.
tags: Each tag is a string value. A given tag can be associated with many taggable items in a site.
Name Type Description
Foreign key/Primary key relation from site_id on this table to id on table, sites
id integer The primary key for the table.
name character varying The value of the tag.
created_at timestamp without time zone The time at which this record was created.
updated_at timestamp without time zone The last time any changes were made to this record.
site_id integer The ID of the site to which the tag belongs.
tasks: Serves to connect schedules with background tasks that should be run on that schedule. The schedule is defined in the schedules table, while the task is defined by type.
Name Type Description
Foreign key/Primary key relation from schedule_id on this table to id on table, schedules
Foreign key/Primary key relation from site_id on this table to id on table, sites
id integer The primary key for the table.
schedule_id integer Links to a schedule. When the schedule's "run_next_at" time arrives, any tasks linked to that schedule will run.
type character varying Identifies the specific type of task that this is. This is how the system identifies what code to execute when this task is to be run.
priority integer An integer where 0 is the highest priority and 10 is the default priority. Other values can be set if desired). Higher priority jobs should be processed earlier.
obj_id integer Some tasks are specific to a particular workbook or datasource. In such cases, the object_id is the primary key of the relevant item, in either the workbooks or datasources tables, as indicated by obj_type.
created_at timestamp without time zone When this record was created.
updated_at timestamp without time zone The last time this record was updated.
site_id integer Some tasks are specific to a particular site. In such cases, this field links to the relevant site in the sites table.
obj_type character varying One of either "Workbook" or "Datasource". Used in conjuction with obj_id, as described there.
luid uuid uuid for tasks used in the REST API
consecutive_failure_count integer The number of times this task has failed.
active boolean If set to false, this means that the task is inactive, implying it won't be run when the schedule triggers
trusted_tickets: This table lists trusted tickets that have been created. Tickets that are redeemed are deleted once used, hence can only be used once. Tickets that are never redeemed become invalid after the time given by "expires_at" and are eventually deleted from the table automatically.
Name Type Description
Foreign key/Primary key relation from site_id on this table to id on table, sites
Foreign key/Primary key relation from user_id on this table to id on table, users
id integer Primary key for the record.
username character varying The name of the user, under whose authority, the ticket is created. Access to content is provided as if the ticket redeemer were this user.
ticket character varying The unique ticket string, i.e. the "value" of the trusted ticket.
client_ip character varying If you have configured wgserver.extended_trusted_ip_checking to true, then the IP address of the client that is authorized to redeem the ticket will be recorded here.
created_at timestamp without time zone When this record was created, i.e. the time of creation of the ticket.
user_id integer Links to the user that has the given username, and is associated with the current site.
expires_at timestamp without time zone Tickets can be redeemed no more than one time, but if it gets any later than this time, then the ticket cannot be redeemed at all. Unless configured differently, this time will be 3 minutes after the ticket is created.
site_id integer The site of the user.
originating_session_id character varying The user session which created the ticket. Null if the ticket was not created by an authenticated user.
guid character varying Uniquely identifies a trusted ticket when ticket hashing is enabled.
salt character varying Combined with ticket to form the hash.
hashed_ticket character varying The hash of the salt and the ticket.
user_default_customized_views: Defines what customized view a user should see for a given view, by default.
Name Type Description
Foreign key/Primary key relation from customized_view_id on this table to id on table, customized_views
Foreign key/Primary key relation from user_id on this table to id on table, users
Foreign key/Primary key relation from view_id on this table to id on table, views
id integer Primary key for the record.
user_id integer A foreign key reference to the user.
view_id integer A foreign key reference to the view.
customized_view_id integer A foreign key reference to the customized view.
created_at timestamp without time zone When this record was created.
updated_at timestamp without time zone When this record was last updated.
user_images: Missing description
Name Type Description
Foreign key/Primary key relation from system_user_id on this table to id on table, system_users
id integer Primary key for the record.
repository_data_id bigint A reference to an entry in the repository_data table.
image_id character varying The id of the image in storage.
image_type character varying A string representing the size of the image.
system_user_id integer The id of the user this image is associated with.
user_prefs: Contains a variety of preferences for the various system users.
Name Type Description
Foreign key/Primary key relation from system_user_id on this table to id on table, system_users
id integer Primary key for the record.
system_user_id integer Foreign key reference to the system_users table. This tells us which system user these preferences apply to.
version integer Used to indicate how to interpret the prefs information.
prefs bytea A serialized object containing the various preferences.
language_id character varying A code indicating the desired language for this system_user
locale_id character varying A code indicating the locale (country and language) for this system_user.
start_page text A relative url of the start page saved by the user.
suppress_getting_started_notifications boolean Flag which indicates if user has selected to suppress getting started notifications (used in online case only so far).
display_mode character varying A display mode "thumbnail" or "list" that the user last selected for viewing contents.
local_timezone_offset integer local user timezone offset (in minutes) from utc from last login location
local_timezone_name character varying best guess of local user timezone name from last login location
lock_version integer Used to implement "optimistic locking." Don't set this or mess with it, it's all handled automatically.
users: Each record links a system_users record to a site. The user's site specific settings are captured here.
Name Type Description
Foreign key/Primary key relation from system_user_id on this table to id on table, system_users
Foreign key/Primary key relation from site_id on this table to id on table, sites
id integer Primary key for the record.
login_at timestamp without time zone The time of the most recent login for this user.
licensing_role_id integer Foreign key reference to the licensing_roles table. Indicates the licensing role that is assigned to this user.
created_at timestamp without time zone When the record was created.
updated_at timestamp without time zone When the record was last updated.
admin_level integer Indicates if this user is a site admin. 5 : site admin, 0 : not site admin.
publisher_tristate integer From among 0 (not), 1 (implicit) and 2 (explicit).
site_id integer A foreign key reference to the site that the user belongs to.
system_user_id integer A foreign key reference to the system user that this user is identified with.
system_admin_auto boolean A flag indicating if the user is a system_admin that is not explicitly a member of the site.
luid uuid An immutable identifier for the record.
lock_version integer Used to implement "optimistic locking." Don't set this or mess with it, it's all handled automatically.
view_metrics_aggregations: Each record represents a partial aggregation of analytics for a given view in a given time interval. It is often necessary to sum across multiple rows to find a total for a given time interval.
Name Type Description
Foreign key/Primary key relation from view_id on this table to id on table, views
id integer Primary key for the record.
view_id integer A foreign key reference to the view.
day_index integer Records what day of the month the analytics are aggregated over. When NULL or 0, the aggregation is for the month and year as designated by month_index and year_index.
month_index integer Records what month of the year the analytics are aggregated over. When NULL or 0, the aggregation is for the year as designated by year_index.
year_index integer Records what year the analytics are aggregated over
view_count integer Records the number of time a view was viewed in the given time interval.
device_type text DSD device type detected (non-null only if view is dashboard in non-authoring mode)
views: Each records represents a view in a workbook.
Name Type Description
Foreign key/Primary key relation from site_id on this table to id on table, sites
Foreign key/Primary key relation from owner_id on this table to id on table, users
Foreign key/Primary key relation from workbook_id on this table to id on table, workbooks
id integer Primary key for the record.
name character varying The name of the view.
repository_url text Uniquely identifies a view. More or less composed of workbook and sheet names, but not totally obviously, especially in the presence of non-ASCII characters. Used in URLs meant to access this view.
description text Can hold a description of the view, but not normally populated.
created_at timestamp without time zone The time at which this record was created.
workbook_id integer A foreign key reference to the workbook the view is part of.
index integer Each view has an index that is unique among views belonging to that workbook.
updated_at timestamp without time zone The last time any changes were made to this record
owner_id integer A foreign key reference to the user who owns this view.
fields text A list of fields extracted from the workbook's twb file.
title text A title for the worksheet extracted from the workbook's twb file.
caption text A descriptive phrase constructed for the worksheet, based on the workbook definition.
sheet_id character varying An identifier for the sheet. Based on the name of the sheet.
state character varying One of either "active" or "disabled".
sheettype character varying One of "story" "dashboard" and "view".
site_id integer A foreign key link to the site to which this view belongs.
repository_data_id bigint A reference to an entry in the repository_data table, which, in turn references the PostgreSQL large object that contains the thumbnail image for this view.
first_published_at timestamp without time zone Records the timestamp for the first time this view was published. This value will not change is the workbook containing this view is later republished.
revision character varying Starts with 1.0 and increments by 0.1 with each republication.
luid uuid An immutable identifier for the record.
thumbnail_id character varying Unique ID used to identify the thumbnail data.
views_stats: This table is used to track how many times each user has accessed different views.
Name Type Description
Foreign key/Primary key relation from site_id on this table to id on table, sites
Foreign key/Primary key relation from view_id on this table to id on table, views
id integer Primary key for the record.
user_id integer A foreign key reference to a particular user.
view_id integer A foreign key reference to the view that was accessed. This field must be populated.
nviews integer Keeps a cummulative count of the number of times the view was accessed by this user.
time timestamp without time zone The time of the most recent access of the specified view by the specified user.
site_id integer The site to which the view and the user belong.
device_type text DSD device type detected (non-null only if view is dashboard in non-authoring mode)
workbook_checksums: This table provides a set of checksums associated with a workbook which can be used to validate existence of a workbook based on its checksum.
Name Type Description
Foreign key/Primary key relation from workbook_id on this table to id on table, workbooks
id integer Primary key for the record.
workbook_id integer Identifies the workbook for which this checksum applies.
checksum character varying The computed checksum of the workbook during download.
created_at timestamp without time zone When this checksum entry was created and will be valid only if associated workbook update timestamp is earlier than this.
expires_at timestamp without time zone When this checksum entry expires and became eligible for cleanup by background task.
workbook_versions: Workbook versions saved on server.
Name Type Description
Foreign key/Primary key relation from workbook_id on this table to id on table, workbooks
Foreign key/Primary key relation from site_id on this table to id on table, sites
id integer The id of a version. Primary key.
site_id integer Reference to entry in sites table. Indicates the site to which this workbook version belongs to.
workbook_id integer A foreign key to the workbooks table. Reference to workbook.
publisher_id integer Reference to user in site users table. User who published this version. Can point to deleted user.
version_number integer The version number.
published_at timestamp without time zone The time when this version was initially published. Copied from workbook record last_updated field at the time of being overwritten.
size bigint The size, in bytes, of this version of workbook.
content_key character varying Key of the workbook as string
publish_metadata text Metadata about how this version was published on server, such as visiblity of views. Metadata is stored as a serialized JSON object.
sos_type character varying The SOS data type under which this version document is stored, or null if it is not stored in SOS.
workbooks: Each record represents a workbook that exists on the server.
Name Type Description
Foreign key/Primary key relation from site_id on this table to id on table, sites
Foreign key/Primary key relation from project_id on this table to id on table, projects
Foreign key/Primary key relation from owner_id on this table to id on table, users
id integer The primary key for the record.
name character varying The name of the workbook.
repository_url text A unique name for the workbook, derived from the ASCII characters in the name, which can be used in URLs to refer to this workbook.
created_at timestamp without time zone The time at which this record was created.
updated_at timestamp without time zone The last time any changes were made to this record.
owner_id integer A foreign key reference to the user that owns this workbook.
project_id integer A foreign key reference to the project in which this workbook exists.
view_count integer Keeps count of the number of views that are associated with this workbook.
size bigint The number of bytes used in storing the workbook information.
embedded text An encrypted keychain holding any credentials stored with the workbook.
thumb_user integer The user to be used when generating the thumbnail image. Null unless specified.
refreshable_extracts boolean Whether the extracts in the workbook can be refreshed.
extracts_refreshed_at timestamp without time zone The time at which the last extract refresh occurred.
lock_version integer Used to implement "optimistic locking." Don't set this or mess with it, it's all handled automatically.
display_tabs boolean If true, then the sheets of the workbook are displayed on tabs.
data_engine_extracts boolean Indicates if this workbook has associated data engine extracts.
incrementable_extracts boolean Indicates if it is possible to perform an incrementable extract refresh for this workbook.
site_id integer The site to which the workbook was published.
revision character varying Starts with 1.0 and increments by 0.1 with each republication.
repository_data_id bigint A reference to an entry in the repository_data table, which, in turn references the PostgreSQL large object that contains the workbook twbx contents. either this field or repository_extract_data_id should be non-NULL. Sometimes both could be non-NULL.
repository_extract_data_id bigint A reference to an entry in the repository_data table, which, in turn references the PostgreSQL large object that contains the workbook twbx contents minus any extract data. either this field or repository_data_id should be non-NULL. Sometimes both could be non-NULL.
first_published_at timestamp without time zone Records the timestamp for the first time this view was published. This value will not change is the workbook containing this view is later republished.
extracts_incremented_at timestamp without time zone The time of the last incremental extract refresh for extracts in this workbook.
default_view_index integer Indicates which view will be shown by default.
luid uuid An immutable identifier for the record.
asset_key_id integer The asset encryption key used to encrypt the keychain in the embedded column.
document_version character varying A string that indicates the version of the document description that was used when saving this workbook.
content_version integer Version number of the workbook. updated on each publish
last_published_at timestamp without time zone Time that the user last published this workbook to server or saved the workbook during web edit. For workbooks that were last published before this column existed, the value will be null.
data_id character varying Unique ID used to identify the workbook data.
reduced_data_id character varying Unique ID used to identify the reduced workbook data.
published_all_sheets boolean True if user previously published all sheets in the workbook, false if they chose to not publish a sheet
_background_tasks: This view combines the important contents of both the background_jobs table and the async_jobs table to give an overall picture of jobs that were given to a backgrounder process.
Name TypeDescription
backgrounder_id character varying The id of the backgrounder process that did the work.
id integer The primary key of either the background_jobs record or the async_jobs record, depending on where this record is coming from.
created_at timestamp without time zone When this record was created.
completed_at timestamp without time zone When the job finished execution. When set, this should generally agree with the updated_at field.
finish_code integer Whether or not the job succeeded. Will be 0 for success, and 1 for failure.
job_type character varying The type of job being run. This looks a bit odd because it comes from a serialized symbol.
progress integer Can be used to indicate percent complete for the job, but in most cases simply gets set to 100 when the job is completed.
args text Used as a means of passing parameters about the background job. This information is stored in a special serialized format, and thus is not easily readable.
notes text Can be used to store additional information about the running of the job.
started_at timestamp without time zone When the execution of the job was started. This is not generally the same as created_at, because it may take some time before a backgrounder "notices" the newly created record and begins to process it.
job_name character varying A nice readable name for this type of job.
priority integer Controls which background_jobs records are processed first. The highest priority is 0, and the lowest is 100. Integer values in between are also valid.
title character varying Can be used to provide some additional information about the job.
processed_on_worker character varying Identifies the machine on which the job is run.
subtitle character varying Can be used to provide some additional information about the job.
language character varying The language for the job is listed here.
site_id integer Links to a site, if one is relevant, otherwise it is left NULL.
locale character varying The locale for the job is listed here.
_comments: Comments users made on views.
Name TypeDescription
id integer Primary key for the underlying comments record.
title text Not used.
comment text Comment text.
commentable_type character varying View.
created_at timestamp without time zone Date when comment was created.
drawing text Not used.
commentable_id integer Corresponding view id.
user_id integer Id of the user who made the comment.
site_id integer Links to the site that the user and this comment belong to.
_customized_views: When a user creates a customized view, the data that supports that goes in the customized_views table, and is reflected in this view.
Name TypeDescription
name character varying A combination of the site name and the customized_view name.
repository_url character varying URL text created from workbook, sheet domain, and url_id.
id integer Primary key for the underlying customized_views record.
size integer The number of bytes it took to describe the changes from the base view to the customized view.
view_name character varying The name of the view that this customized view is based on.
sheet_id character varying An identifier for the sheet. Based on the name of the sheet.
workbook_url text A unique name for the workbook, that contains the base view, derived from the ASCII characters in the name, which can be used in URLs to refer to this workbook.
workbook_name character varying The actual name of the workbook, that contains the base view, derived from the ASCII characters in the name, which can be used in URLs to refer to this workbook.
email character varying The email of the system_user associated with this customized view.
user_name character varying The name of the system_user associated with this customized view.
site_id integer A foreign key to the site that this customized view is associated with (the site of the user who created it).
_datasources: Shows all Published datasources on server, along with some associated information.
Name TypeDescription
id integer Primary key for the underlying datasources record.
name character varying The name of the published datasource.
datasource_url text Uniquely identifies a datasource. More or less consists of a slightly modified name, but not totally obviously, especially in the presence of non-ASCII characters. Used in URLs meant to access this datasource.
owner_id integer The user ID of the owner/uploader of the datasource.
owner_name character varying The name of the system_user linked to owner_id
created_at timestamp without time zone When this record was created.
updated_at timestamp without time zone When this record was last updated.
size bigint The size in bytes of the datasource.
project_id integer The associated project ID where the datasource was published.
project_name character varying The name of the project linked via project_id.
server text DNS server name to connect to (for the associated data_connection record).
dbclass character varying Type of data connection (ie mysql, postgres, sqlproxy etc) (for the associated data_connection record).
port integer TCP port number of the connect (eg. 5432 for postgres) (for the associated data_connection record).
username character varying Username to use when connecting.
dbname character varying The database name associated with the linked data_connection record.
owner_type character varying "Datasource"
system_user_id integer The system_user linked to the user whose id is owner_id.
site_id integer The site that contains this datasource.
domain_id integer A foreign key reference to the domain of the owner.
domain_name character varying The name is either "local" or the name of some Active Directory group.
_datasources_stats: Some historical useage information about datasources. Based on the records that exist in the historical events tables.
Name TypeDescription
nviews bigint The number of times that the datasource has been accessed.
last_access_time timestamp without time zone The most recent access of the datasource
datasource_id integer Links to the datasource whose usage is being described.
site_id integer The site in which this datasource exists.
_groups: A grouping of users. Can be locally created or imported from Active Directory. Reflects the contents of the groups table and associated tables.
Name TypeDescription
id integer The primary key of the underlying groups record.
name character varying The name that was given to the group.
site_name character varying The name of the site that this group belongs in.
domain_name character varying The name of the domain that this group is linked to.
domain_short_name character varying A short version of the domain that this group is linked to.
domain_family character varying Either local or ActiveDirectory.
_http_requests: Each record represents a request received by Tableau Server. Reflects data in the http_requests table.
Name TypeDescription
controller character varying The part of the application that received the request.
action character varying The action requested.
http_referer character varying The referrer.
http_user_agent character varying The agent string supplied by the client.
http_request_uri text The requested URI.
remote_ip character varying The client's IP address (from the perspective of the server).
created_at timestamp without time zone When this record was created.
session_id character varying The session with which the request is associated.
completed_at timestamp without time zone When the request was completed.
port integer The port on which the request was received.
user_id integer The user associated with the request.
worker character varying Which worker machine received the request.
vizql_session text The vizql session associated with this request.
user_ip character varying The IP address of the originator of the request.
currentsheet character varying Which sheet was being viewed.
site_id integer The site associated with the request.
_projects: Each row of the table corresponds to a project on Tableau Server.
Name TypeDescription
id integer Primary key for the underlying record in the projects table.
name character varying The name of the project.
created_at timestamp without time zone The time at which this record was created.
owner_id integer The id of the user who owns this project.
owner_name character varying The name of the system_user who owns this project.
system_user_id integer The id of the system_user who owns this project.
site_id integer Refers to the site which contains this project.
_schedules: Records define a schedule according to which certain regular tasks may be performed (see tasks table). They also indicate the next time at which the schedule will be triggered.
Name TypeDescription
id integer Primary key for the record in the underlying schedules table.
name character varying A schedule can be given a name, which is stored here.
active boolean If set to false, this means that the schedule is inactive, meaning that no tasks will be performed when the schedules triggers.
priority integer Priority can range from 1 to 100, with lower values corresponding to higher priority.
schedule_type integer One of 0 (Hourly), 1 (Daily), 2 (Weekly), 3 (Monthly).
day_of_week_mask integer Indicates which day of the week this schedule will run. The information is encoded in the given integer. To interpret it, convert the integer to binary. The days of the week correspond to Sunday : 1, Monday : 10, Tuesday : 100, Wednesday : 1000, Thursday : 10000, Friday : 100000, Saturday : 1000000.
day_of_month_mask integer Indicates which day of the month this schedule will run. The information is encoded in the given integer. To interpret it, convert the integer to binary. The days of the month correspond to 1st : 1, 2nd: 10, 3rd: 100, 4th: 1000, 5th: 10000, etc.
start_at_minute integer The minute following the start of the designated time period implied by the schedule_type. For example, for a daily schedule, this would be number of minutes past midnight at the start of the day. For hourly, it would be the number of minutes past the beginning of the hour.
minute_interval integer Once the schedule triggers, it will retrigger at this interval during the time period implied by the schedule_type or until end_at_minute, or end_schedule_at.
end_at_minute integer The minute following the start of the designated time period implied schedule_type, at which the schedule should stop triggering.
end_schedule_at timestamp without time zone Used to indicate a point in time, after which the schedule should never trigger.
run_next_at timestamp without time zone When the schedule will next trigger.
created_at timestamp without time zone The time at which this record was created.
updated_at timestamp without time zone The last time any changes were made to this record.
hidden boolean If set to true, then this schedule will not be listed in the GUI, otherwise it will be.
serial_collection_id integer A foreign key to the serial_collections table. Two jobs with the same serial_collection_id cannot be processed simultaneously. When the job record for a task linked to this schedule is created, it is assigned this serial_collection_id.
lock_version integer Used to implement "optimistic locking" by JPA/Hibernate. The counter increases each time the record is changed. Not useful for customers.
scheduled_action integer Used to classify schedules into one of two categories: 0 (Extract related) 1 (Subscription related)
scheduled_action_type text A friendly string representation of the type of scheduled action.
_sessions: Settings associated with a user's browser session.
Name TypeDescription
session_id character varying Session identifier.
updated_at timestamp without time zone Time when session was last updated, used to expire inactive sessions.
user_id integer Foreign key to users table. Tells the user whose session this is.
user_name character varying The name of the system_user linked to the user whose session this is.
system_user_id integer The id of the system_user linked to the user whose session this is.
site_id integer The site that this session belongs to.
_sites: Each record represents a site. Each site holds its own workbooks, datasources, users, etc. Strict isolation between the contents of each site is maintained.
Name TypeDescription
id integer Primary key for the underlying sites record.
name character varying The name of the site.
url_namespace character varying String used in the construction of URLs that target this site.
status character varying One of "active" "suspended" or "locked".
_subscriptions: Each record provides information about subscriptions that are scheduled. Subscriptions are a mechanism for receiving specified content by email on some schedule.
Name TypeDescription
id integer Primary key for the underlying subscriptions record.
subject character varying A string that describes the nature of the subscription.
content_type text Describes what type of content is being delivered by this subscription. One of: "Customized View - Single View", "Workbook", "Single View", or "Customized View - Workbook".
view_url text A URL string that describes the view to be delivered, when the subscription is for a view.
workbook_url text A URL string that describes the workbook to be delivered, when the subscription is for a workbook.
customized_view_id integer A foreign key reference to the customized view, if the subscription is for a customized view.
last_sent timestamp without time zone The last time at which the the subscription was sent.
user_id integer A foreign key reference to the user who will receive the subscription.
user_name character varying The name of the system_user who will receive the subscription.
site_id integer The site that the subscription (and the user) belongs to.
site_name character varying The name of the site that the subscription (and the user) belongs to.
schedule_name character varying The name of the schedule that this subscription runs under.
schedule_active boolean If set to false, this means that the subscription is inactive.
schedule_run_next_at timestamp without time zone The next time the subscription should be sent.
schedule_priority integer Priority can range from 1 to 100, with lower values corresponding to higher priority.
_system_users: Each record represents a user of the server. These records correspond to login identity. A single system_user may potentially be able to login to multiple sites. The linkage between a system_user and their allowed sites is defined through the "users" table.
Name TypeDescription
id integer Primary key for the underlying system_user record.
name character varying The username of the user.
email character varying The email of the user.
friendly_name character varying A friendly name that might be used in the GUI to refer to the user.
custom_display_name boolean If set to true, this prevents the friendly_name from potentially being overwritten by Active Airectory information when the user is read in from Active Directory. Seldom done.
admin_level integer Indicates if the user is a system administrator. 10 : system admin, 0 : not a system admin
domain_name character varying The name of the domain that the user belongs to. The name is either "local" or the name of some Active Directory group.
domain_short_name character varying An alternate shorter form of the name
domain_family character varying Either local or ActiveDirectory.
_tags: Each tag is a string value. A given tag can be associated with many taggable items in a site.
Name TypeDescription
tag_id integer The primary key for the underlying tags table.
tag_name character varying The value of the tag.
object_type character varying The type of the taggable item - this is used to identify which table to join to.
taggable_id integer The ID of the taggable item.
object_id integer The same as taggable_id.
object_name character varying The name of the view, workbook, or datasource that is being tagged.
user_id integer The ID of the user that owns the tagging.
user_name character varying The name of the system_user that owns the tagging.
system_user_id integer The id of the system_user that owns the tagging.
site_id integer The site in which the tagged object exists (likewise the user, etc.).
_users: Information relating to users.
Name TypeDescription
id integer Primary key for the underlying user record.
name character varying The name of the system_user linked to the user record.
login_at timestamp without time zone The time of the most recent login for this user.
friendly_name character varying The friendly name of the system_user linked to the user record.
licensing_role_id integer Foreign key reference to the licensing_roles table. Indicates the licensing role that is assigned to this user.
licensing_role_name character varying The name of the licensing role that is assigned to this user.
domain_id integer The domain_id of the system_user linked to the user record.
system_user_id integer The id of the system_user linked to the user record.
domain_name character varying The domain_name of the system_user linked to the user record.
domain_short_name character varying The a shorter version of the domain_name of the system_user linked to the user record.
site_id integer The id of the site that the user belongs to.
_views: Each records represents a view in a workbook.
Name TypeDescription
id integer Primary key for the underlying views record.
name character varying The name of the view.
view_url text Uniquely identifies a view. More or less composed of workbook and sheet names, but not totally obviously, especially in the presence of non-ASCII characters. Used in URLs meant to access this view.
created_at timestamp without time zone The time at which the underlying views record was created.
owner_id integer A foreign key reference to the user who owns this view.
owner_name character varying The name of the user who owns this view.
workbook_id integer A foreign key reference to the workbook the view is part of.
index integer Each view has an index that is unique among views belonging to that workbook.
title text A title for the worksheet extracted from the workbook's twb file.
caption text A descriptive phrase constructed for the worksheet, based on the workbook definition.
site_id integer A foreign key link to the site to which this view belongs.
_views_stats: Used to track how many times each user has accessed different views.
Name TypeDescription
users_id integer A foreign key reference to a particular user.
system_users_name character varying The name of the system_user that corresponds to the user.
users_login_at timestamp without time zone The time of the most recent login for this user.
system_users_friendly_name character varying The friendly_name of the system_user that corresponds to the user.
views_id integer A foreign key reference to the view that was accessed. This field must be populated.
system_users_id integer The id of the system_user that corresponds to the user.
views_name character varying The name of the view that was accessed.
views_url text Uniquely identifies a view. More or less composed of workbook and sheet names, but not totally obviously, especially in the presence of non-ASCII characters. Used in URLs meant to access this view.
views_workbook_id integer A foreign key reference to the workbook the view is part of.
views_created_at timestamp without time zone The time at which the view was created.
views_owner_id integer A foreign key reference to the user who owns the view.
views_index integer Each view has an index that is unique among views belonging to that workbook.
views_title text A title for the worksheet extracted from the workbook's twb file.
views_caption text A descriptive phrase constructed for the worksheet, based on the workbook definition.
device_type text DSD device type detected (non-null only if view is dashboard in non-authoring mode)
nviews integer Keeps a cummulative count of the number of times the view was accessed by this user.
last_view_time timestamp without time zone The time of the most recent access of the specified view by the specified user.
site_id integer Links to the site that contains the view.
_workbooks: Each record represents a workbook that exists on the server.
Name TypeDescription
id integer The primary key for the underlying workbook record.
name character varying The name of the workbook.
workbook_url text A unique name for the workbook, derived from the ASCII characters in the name, which can be used in URLs to refer to this workbook.
created_at timestamp without time zone The time at which the workbook record was created.
updated_at timestamp without time zone The last time any changes were made to this workbook record.
owner_id integer A foreign key reference to the user that owns this workbook.
project_id integer A foreign key reference to the project in which this workbook exists.
size bigint The number of bytes used in storing the workbook information.
view_count integer Keeps count of the number of views that are associated with this workbook.
owner_name character varying The name of the system_user who is the owner.
project_name character varying The name of the project that this workbook is part of.
system_user_id integer The id of the system_user who is the owner.
site_id integer Links to the site that contains this workbook.
domain_id integer A foreign key reference to the domain of the owner.
domain_name character varying The name is either "local" or the name of some Active Directory group.
users_view: Each record corresponds to a user on the system. The data presented is a combination of user data and data from the linked system_user.
Name TypeDescription
email character varying The email of the system_user.
login_at timestamp without time zone The last time the system_user logged in.
name character varying The name of the system_user.
id integer The id of the underlying users record.
system_user_id integer The id of the linked system_users record.