From 96d5ef2bcd99b900730b444bc77d495e6f97bf19 Mon Sep 17 00:00:00 2001 From: Steve Nyemba Date: Tue, 12 Jan 2021 13:48:04 -0600 Subject: [PATCH] documentation, for export function --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 6c0a632..d4141ba 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,23 @@ We wrote this frame to be used in both command line or as a library within in yo --config configuration to support data-store + The configuration file template for exports is as follows : + + + {"provider":"","db":"mydatabase",["host":"server-name","port":5432,"user":"me","password":"!@#z4qm","schema":"target-schema"]} + + **parameters:** + + provider postgresql,redshift,mysql or mariadb (supported providers) + db name of the database + + **optional:** + schema name of the target schema. If not provided we will assume the default + host host of the database. If not provided assuming localhost + port port value of the database if not provided the default will be used + user database user name. If not provided we assume security settings to trust + password password of database user. If not set we assume security settings to trust + **Embedded in Code :** The Healthcare/IO **parser** can be used within your code base as a library and handle storing data in a data store of choice