diff --git a/adaptors/mongodb.md b/adaptors/mongodb.md new file mode 100644 index 00000000000..5c6f560b042 --- /dev/null +++ b/adaptors/mongodb.md @@ -0,0 +1,36 @@ +--- +title: MongoDB Adaptor +--- + +## About MongoDB + +[MongoDB](https://www.mongodb.com/) is a NoSQL, document-oriented database that stores data in BSON (Binary JSON) format, enabling easy storage and retrieval of complex and hierarchical data structures + +## Integration Options + +The `mongodb` adaptor provides direct database connections for accessing data and executing SQL and standard database operations. See [functions](/adaptors/packages/mongodb-docs) for more on how to use this adaptor. + + +## Authentication + +See the [MongoDB docs](https://www.mongodb.com/docs/) for the latest on supported authentication methods. When integrating with a MongoDB database via OpenFn, you authenticate via SSH using authorized database credentials. See this adaptor's [configuration docs](/adaptors/packages/mongodb-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this: + +``` +{ + "clusterHostname": "yourCluster-xxxyzzz.mongodb.net", + "username": "admin", + "password": "@secret(!)Pass" +} +``` + +### Helpful Links + +1. [MongoDB documentation](https://www.mongodb.com/docs/) + + + + + + diff --git a/adaptors/mssql.md b/adaptors/mssql.md new file mode 100644 index 00000000000..50b809a17ac --- /dev/null +++ b/adaptors/mssql.md @@ -0,0 +1,37 @@ +--- +title: MSSQL Adaptor +--- + +## About MSSQL + +[Microsoft SQL Server](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) (MSSQL) is a relational database management system (RDBMS) developed by Microsoft. It supports a wide variety of applications, including data warehousing, transaction processing, and business intelligence. It can be accessed and manipulated using SQL to extract or load data. + +## Integration Options + +The `mssql` adaptor provides direct database connections for accessing data and executing SQL and standard database operations. See [functions](/adaptors/packages/mssql-docs) for more on how to use this adaptor. + + +## Authentication + +See [MSSQL docs](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) for the latest on supported authentication methods. When integrating with an MSSQL database via OpenFn, you authenticate via SSH using authorized database credentials. See this adaptor's [Configuration docs](/adaptors/packages/mssql-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this: + +``` +{ + "server": "something.database.windows.net", + "database": "demo-db", + "userName": "admin", + "password": "@super(!)Password" +} +``` + +### Helpful Links + +1. [MSSQL documentation](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) + + + + + + diff --git a/adaptors/mysql.md b/adaptors/mysql.md new file mode 100644 index 00000000000..bc64964a31d --- /dev/null +++ b/adaptors/mysql.md @@ -0,0 +1,37 @@ +--- +title: MySQL Adaptor +--- + +## About MySQL + +MySQL is a free and open-source relational database management system. It can be accessed and manipulated using SQL to extract or load data. + +## Integration Options + +The `mysql` adaptor provides direct database connections for accessing data and executing SQL and standard database operations. See [functions](/adaptors/packages/mysql-docs) for more on how to use this adaptor. + + +## Authentication + +See the [MySQL docs](https://dev.mysql.com/doc/) for the latest on supported authentication methods. When integrating with a MySQL database via OpenFn, you authenticate via SSH using authorized database credentials. See this adaptor's [configuration docs](/adaptors/packages/mysql-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this: + +``` +{ + "host": "some-host-url.compute-1.amazonaws.com", + "database": "demo-db", + "user": "admin-demo", + "password": "@super(!)Secretpass" +} +``` + +### Helpful Links + +1. [MySQL documentation](https://dev.mysql.com/doc/) + + + + + +