https://github.com/neflyte/fdwctl
A PostgreSQL Foreign Data Wrapper (FDW) management CLI
https://github.com/neflyte/fdwctl
database postgres postgresql
Last synced: 6 months ago
JSON representation
A PostgreSQL Foreign Data Wrapper (FDW) management CLI
- Host: GitHub
- URL: https://github.com/neflyte/fdwctl
- Owner: neflyte
- License: mit
- Created: 2020-06-26T21:27:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-05T00:05:11.000Z (over 2 years ago)
- Last Synced: 2024-06-21T08:27:14.811Z (about 2 years ago)
- Topics: database, postgres, postgresql
- Language: Go
- Homepage:
- Size: 170 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
A PostgreSQL Foreign Data Wrapper (FDW) management CLI
-
[Features](#features) | [Installation](#installation) | [Usage](#usage) | [Configuration](#configuration)
### What is it?
`fdwctl` is a command line tool to manage foreign servers, user mappings, and importing remote schemas using the PostgreSQL Foreign Data Wrapper (FDW).
### What does it do?
`fdwctl` allows create, read, update, and delete (CRUD) operations on foreign servers, user mappings, and importing remote schemas with reasonably simple commands. It also can attempt to create local ENUM types that are used by a remote schema before importing that schema.
The CLI interface is written with the original intention of being used as part of Kubernetes deployments.
### Features
- Supports PostgreSQL `postgres_fdw` wrapper; support for other wrappers is pending
- Can apply a desired configuration state to a database
- Single, statically-linked binary; can be compiled on any platform supporting Golang 1.14+
- Multiple log message formats (Text, JSON; Elasticstack schema support is pending)
### Installation
#### Using Go
```shell script
go install https://github.com/neflyte/fdwctl/cmd/fdwctl
```
### Usage
```
Usage:
fdwctl [command]
Available Commands:
apply Apply a desired state
create Create objects
drop Drop (delete) objects
edit Edit objects
help Help about any command
list List objects
Flags:
--config string location of program configuration file
--connection string database connection string
-h, --help help for fdwctl
--logformat string log output format [text, json] (default "text")
--loglevel string log message level [trace, debug, info, warn, error, fatal, panic] (default "trace")
--nologo suppress program name and version message
Use "fdwctl [command] --help" for more information about a command.
```
#### Examples
##### Create the `postgres_fdw` extension
```shell script
fdwctl create extension postgres_fdw
```
##### Create a foreign server
```shell script
fdwctl create server my-remotedb --serverhost remotedb1 --serverport 5432 --serverdbname remotedb
```
##### Create a user mapping
```shell script
fdwctl create usermap --servername my-remotedb --localuser fdw --remoteuser remoteuser --remotepassword 'r3m0TE!'
```
### Configuration
The application configuration file is in YAML format and is located at `${HOME}/.config/fdwctl/config.yaml`. An explicit configuration file can be specified by using the `--config` argument. In addition to YAML, JSON format is also supported.
#### Example Configuration File
The following is an example of the application configuration file in YAML format.
```yaml
FDWConnection: "host=localhost port=5432 dbname=fdw user=fdw sslmode=disable"
FDWConnectionSecret:
value: "passw0rd"
DesiredState:
Extensions:
- name: postgres_fdw
Servers:
- name: remotedb
host: remotedb1
port: 5432
db: remotedb
UserMap:
- localuser: fdw
remoteuser: remoteuser
remotesecret:
value: "r3m0TE!"
#fromEnv: "REMOTEDB_CREDENTIAL"
#fromFile: /tmp/credential.txt
#fromK8s:
#namespace: default
#secretName: my-secret-object
#secretKey: postgresql-password
Schemas:
- localschema: remotedb
remoteschema: public
importenums: true
enumconnection: "postgres://remoteuser@localhost:15432/remotedb?sslmode=disable"
enumsecret:
value: "r3m0TE!"
#fromEnv: "REMOTEDB_CREDENTIAL"
#fromFile: /tmp/credential.txt
#fromK8s:
#namespace: default
#secretName: my-secret-object
#secretKey: postgresql-password
```