n8n/docs/generated/postgres-schema/public.credentials_entity.md
Albert Alises 13becf336c
feat(core): Add instance credential database schema (#34709)
Co-authored-by: Danny Martini <danny@n8n.io>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-24 09:37:33 +00:00

7.2 KiB

public.credentials_entity

Columns

Name Type Default Nullable Children Parents Comment
createdAt timestamp(3) with time zone CURRENT_TIMESTAMP(3) false
data text false
id varchar(36) false public.chat_hub_agents public.chat_hub_sessions public.credential_dependency public.dynamic_credential_entry public.dynamic_credential_user_entry public.instance_ai_mcp_registry_connections public.instance_credential_assignment public.shared_credentials
isGlobal boolean false false
isManaged boolean false false
isResolvable boolean false false
name varchar(128) false
resolvableAllowFallback boolean false false
resolverId varchar(16) true public.dynamic_credential_resolver
type varchar(128) false
updatedAt timestamp(3) with time zone CURRENT_TIMESTAMP(3) false
usageScope varchar(16) 'project'::character varying false Where the credential may be consumed: a project-owned feature or an instance-level feature

Constraints

Name Type Definition
CHK_credentials_entity_usageScope CHECK CHECK ((("usageScope")::text = ANY ((ARRAY['project'::character varying, 'instance'::character varying])::text[])))
credentials_entity_createdAt_not_null n NOT NULL "createdAt"
credentials_entity_data_not_null n NOT NULL data
credentials_entity_id_not_null1 n NOT NULL id
credentials_entity_isGlobal_not_null n NOT NULL "isGlobal"
credentials_entity_isManaged_not_null n NOT NULL "isManaged"
credentials_entity_isResolvable_not_null n NOT NULL "isResolvable"
credentials_entity_name_not_null n NOT NULL name
credentials_entity_pkey PRIMARY KEY PRIMARY KEY (id)
credentials_entity_resolvableAllowFallback_not_null n NOT NULL "resolvableAllowFallback"
credentials_entity_resolverId_foreign FOREIGN KEY FOREIGN KEY ("resolverId") REFERENCES dynamic_credential_resolver(id) ON DELETE SET NULL
credentials_entity_type_not_null n NOT NULL type
credentials_entity_updatedAt_not_null n NOT NULL "updatedAt"
credentials_entity_usageScope_not_null n NOT NULL "usageScope"

Indexes

Name Definition
IDX_credentials_entity_is_global CREATE INDEX "IDX_credentials_entity_is_global" ON public.credentials_entity USING btree (id) WHERE ("isGlobal" = true)
credentials_entity_pkey CREATE UNIQUE INDEX credentials_entity_pkey ON public.credentials_entity USING btree (id)
idx_07fde106c0b471d8cc80a64fc8 CREATE INDEX idx_07fde106c0b471d8cc80a64fc8 ON public.credentials_entity USING btree (type)
pk_credentials_entity_id CREATE UNIQUE INDEX pk_credentials_entity_id ON public.credentials_entity USING btree (id)

Relations

erDiagram

"public.chat_hub_agents" }o--o| "public.credentials_entity" : "FOREIGN KEY (#quot;credentialId#quot;) REFERENCES credentials_entity(id) ON DELETE SET NULL"
"public.chat_hub_sessions" }o--o| "public.credentials_entity" : "FOREIGN KEY (#quot;credentialId#quot;) REFERENCES credentials_entity(id) ON DELETE SET NULL"
"public.credential_dependency" }o--|| "public.credentials_entity" : "FOREIGN KEY (#quot;credentialId#quot;) REFERENCES credentials_entity(id) ON DELETE CASCADE"
"public.dynamic_credential_entry" }o--|| "public.credentials_entity" : "FOREIGN KEY (credential_id) REFERENCES credentials_entity(id) ON DELETE CASCADE"
"public.dynamic_credential_user_entry" }o--|| "public.credentials_entity" : "FOREIGN KEY (#quot;credentialId#quot;) REFERENCES credentials_entity(id) ON DELETE CASCADE"
"public.instance_ai_mcp_registry_connections" }o--|| "public.credentials_entity" : "FOREIGN KEY (#quot;credentialId#quot;) REFERENCES credentials_entity(id) ON DELETE CASCADE"
"public.instance_credential_assignment" }o--|| "public.credentials_entity" : "FOREIGN KEY (#quot;credentialId#quot;) REFERENCES credentials_entity(id) ON DELETE RESTRICT"
"public.shared_credentials" }o--|| "public.credentials_entity" : "FOREIGN KEY (#quot;credentialsId#quot;) REFERENCES credentials_entity(id) ON DELETE CASCADE"
"public.credentials_entity" }o--o| "public.dynamic_credential_resolver" : "FOREIGN KEY (#quot;resolverId#quot;) REFERENCES dynamic_credential_resolver(id) ON DELETE SET NULL"

"public.credentials_entity" {
  timestamp_3__with_time_zone createdAt
  text data
  varchar_36_ id
  boolean isGlobal
  boolean isManaged
  boolean isResolvable
  varchar_128_ name
  boolean resolvableAllowFallback
  varchar_16_ resolverId FK
  varchar_128_ type
  timestamp_3__with_time_zone updatedAt
  varchar_16_ usageScope
}
"public.chat_hub_agents" {
  timestamp_3__with_time_zone createdAt
  varchar_36_ credentialId FK
  varchar_512_ description
  json files
  json icon
  uuid id
  varchar_64_ model
  varchar_256_ name
  uuid ownerId FK
  varchar_16_ provider
  json suggestedPrompts
  text systemPrompt
  timestamp_3__with_time_zone updatedAt
}
"public.chat_hub_sessions" {
  uuid agentId FK
  varchar_128_ agentName
  timestamp_3__with_time_zone createdAt
  varchar_36_ credentialId FK
  uuid id
  timestamp_3__with_time_zone lastMessageAt
  varchar_256_ model
  uuid ownerId FK
  varchar_16_ provider
  varchar_256_ title
  varchar_16_ type
  timestamp_3__with_time_zone updatedAt
  varchar_36_ workflowId FK
}
"public.credential_dependency" {
  timestamp_3__with_time_zone createdAt
  varchar_36_ credentialId FK
  varchar_255_ dependencyId
  varchar_64_ dependencyType
  integer id
}
"public.dynamic_credential_entry" {
  timestamp_3__with_time_zone createdAt
  varchar_16_ credential_id FK
  text data
  varchar_16_ resolver_id FK
  varchar_2048_ subject_id
  timestamp_3__with_time_zone updatedAt
}
"public.dynamic_credential_user_entry" {
  timestamp_3__with_time_zone createdAt
  varchar_16_ credentialId FK
  text data
  varchar_16_ resolverId FK
  timestamp_3__with_time_zone updatedAt
  uuid userId FK
}
"public.instance_ai_mcp_registry_connections" {
  timestamp_3__with_time_zone createdAt
  varchar_36_ credentialId FK
  uuid id
  varchar_255_ serverSlug FK
  json toolFilter
  timestamp_3__with_time_zone updatedAt
  uuid userId FK
}
"public.instance_credential_assignment" {
  timestamp_3__with_time_zone createdAt
  varchar_36_ credentialId FK
  varchar_128_ credentialUseId
  timestamp_3__with_time_zone updatedAt
}
"public.shared_credentials" {
  timestamp_3__with_time_zone createdAt
  varchar_36_ credentialsId FK
  varchar_36_ projectId FK
  text role
  timestamp_3__with_time_zone updatedAt
}
"public.dynamic_credential_resolver" {
  text config
  timestamp_3__with_time_zone createdAt
  varchar_16_ id
  varchar_128_ name
  varchar_128_ type
  timestamp_3__with_time_zone updatedAt
}

Generated by tbls