README
¶
Apache CouchDB
Extract document metadata from a CouchDB server.
Usage
source:
name: couchdb
config:
connection_url: http://admin:pass123@localhost:5984/
exclude:
databases:
- database_a
- database_b
Configuration
| Key | Type | Required | Description |
|---|---|---|---|
connection_url |
string |
Yes | URL to access the CouchDB server. |
exclude.databases |
[]string |
No | List of database names to exclude. Internal databases (_global_changes, _replicator, _users) are excluded by default. |
Entities
- Entity type:
table - URN format:
urn:couchdb:{scope}:table:{database}.{docID}
| Property | Type | Description |
|---|---|---|
properties.columns |
[]object |
List of column objects derived from document fields. |
properties.columns[].name |
string |
Field name. |
properties.columns[].data_type |
string |
Inferred Go type of the field value (e.g. float64, string). |
properties.columns[].description |
string |
Document revision string (if available). |
properties.columns[].length |
int |
Document size in bytes (if non-zero). |
Edges
This extractor does not emit edges.
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 ¶
This section is empty.
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 connection URL 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 CouchDB
Source Files
Click to show internal directories.
Click to hide internal directories.