README
¶
PostgreSQL
Extract table metadata from a PostgreSQL server.
Usage
source:
name: postgres
config:
connection_url: postgres://admin:pass123@localhost:5432/postgres?sslmode=disable
exclude:
databases:
- testDB
- secondaryDB
Configuration
| Key | Type | Required | Description |
|---|---|---|---|
connection_url |
string |
Yes | PostgreSQL connection URL. |
exclude.databases |
[]string |
No | List of databases to exclude. |
Entities
- Type:
table - URN format:
urn:postgres:{scope}:table:{database}.{table}
Properties
| Property | Type | Description |
|---|---|---|
properties.columns |
[]object |
List of column metadata objects. |
properties.grants |
[]object |
List of user privilege grants (when available). |
Column object
| Field | Type | Description |
|---|---|---|
name |
string |
Column name. |
data_type |
string |
Data type of the column. |
is_nullable |
bool |
Whether the column is nullable. |
length |
int |
Maximum character length (omitted when 0). |
Grant object
| Field | Type | Description |
|---|---|---|
user |
string |
Grantee name. |
privilege_types |
[]string |
List of granted privileges (e.g. SELECT, INSERT). |
Edges
| Source | Target | Type | Description |
|---|---|---|---|
table |
table |
references |
Foreign key relationship to the referenced table. |
Contributing
Refer to the contribution guidelines for information on contributing to this module.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Config ¶
type Config struct {
ConnectionURL string `json:"connection_url" yaml:"connection_url" mapstructure:"connection_url" validate:"required"`
Exclude Exclude `json:"exclude" yaml:"exclude" mapstructure:"exclude"`
}
Config holds the set of configuration options for the extractor
type Exclude ¶ added in v0.13.0
type Exclude struct {
Databases []string `json:"databases" yaml:"databases" mapstructure:"databases"`
}
Exclude contains the list of databases to skip during extraction.
type Extractor ¶
type Extractor struct {
plugins.BaseExtractor
// contains filtered or unexported fields
}
Extractor manages the extraction of data from the extractor
Source Files
Click to show internal directories.
Click to hide internal directories.