Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adaptors overview pages #616

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions adaptors/mongodb.md
Original file line number Diff line number Diff line change
@@ -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/)






37 changes: 37 additions & 0 deletions adaptors/mssql.md
Original file line number Diff line number Diff line change
@@ -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)






37 changes: 37 additions & 0 deletions adaptors/mysql.md
Original file line number Diff line number Diff line change
@@ -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/)






Loading