https://github.com/desteves/realm

Go package for MongoDB Realm (previously known as Stitch)
https://github.com/desteves/realm

Last synced: 9 days ago
JSON representation

Go package for MongoDB Realm (previously known as Stitch)

• Host: GitHub
• URL: https://github.com/desteves/realm
• Owner: desteves
• License: apache-2.0
• Created: 2020-01-24T17:24:31.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-01-25T23:14:42.000Z (about 3 years ago)
• Last Synced: 2024-09-23T09:15:47.851Z (4 months ago)
• Language: Go
• Homepage:
• Size: 74.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mongodb realm go package

Contains a [mongoDB Realm](https://docs.mongodb.com/realm/) [Authentication package](pkg/auth) and a [GraphQL Client package](pkg/graphql) which authenticates and runs queries and mutations against [Realm's GraphQL Server](https://docs.mongodb.com/realm/graphql).

See [examples/](examples/)

## Usage 

Note: This requires to have Atlas and Realm set up. See below for details. 

```bash

go get https://github.com/desteves/realm

import  "github.com/desteves/realm/pkg/graphql"

```

## Atlas Setup 

- Create new project under an organization. Register [here](https://www.mongodb.com/cloud/atlas/register)

- Create new free cluster, call it `graphqlDatabase`.

- Load 'Sample Data Set'. Steps [here](https://docs.atlas.mongodb.com/sample-data/)

## Realm Setup

### Via the UI

- Create new realm app, call it `graphqlServer`.  Steps [here](https://docs.mongodb.com/realm/get-started/create-realm-app)

  - Write down app id `graphqlserver-?????`

- Enable `anonymous` authentication. Steps [here](https://docs.mongodb.com/realm/authentication/anonymous)

- Enable GraphQL and configure. Steps [here](https://docs.mongodb.com/realm/graphql/expose-data)

  - Generate schemas

  - Select any of the `sample-*` databases/collections and click 'Generate Schema'. 

    - Enable read/write access

    

#### __(Optional)  Set up webhook__

This is an additional check to verify our client has network connectivty.

Follow the steps [listed here](https://docs.mongodb.com/realm/services/configure/service-webhooks)

- Name the service as `ping`

- Name the webhook as `test` 

- Only allow the `GET` HTTP Method

- Paste the following in the function

```javascript

  // This function is the webhook's request handler.

  exports = function(payload, response) {

    response.setStatusCode(200);

    response.setBody(

    "{'message': 'pong'}"

  );

  };

```

See [examples/anonymousauth/main.go](examples/anonymousauth/main.go) for usage.

#### __(Optional)  Set up dummy GraphQL record__

This is to verify our client can reach the graphql server and obtain a valid response.

Insert the following to your atlas cluster. This example is from the mongo shell:

```javascript

var appid = "graphqlserver-?????" // <------- UPDATE THIS!!!

use graphql

db.health.insertOne({

 "appid": appid,

 "description": "Checks GraphQL Server is reachable and operational",

 "status": "pass",

 "endpoint": "https://realm.mongodb.com/api/client/v2.0/app/"+appid+"/graphql"

})

```

See [examples/graphqlhealthcheck/main.go](examples/graphqlhealthcheck/main.go) for usage.

### Via the CLI

```

npm install -g mongodb-realm-cli

realm-cli login --api-key="AAAAAAA" --private-api-key="AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA"

// todo

```

## TODO (work in progress)

- BUG: Don't show errors array when no error.

- Add Atlas API && Realm-CLI commands for the Atlas+Realm Set up

- Testing

## References

- [MongoDB Go Driver](https://github.com/mongodb/mongo-go-driver)

- [MongoDB GraphQL Docs](https://docs.mongodb.com/realm/graphql)