Skip to content
Merged
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
3 changes: 2 additions & 1 deletion badger/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Overview
title: Badger
description: Welcome to the Badger docs!
mode: "wide"
sidebarTitle: "Overview"
"og:title": "Overview - Badger"
---

Expand Down
3 changes: 2 additions & 1 deletion community-and-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ If you encounter a bug or have a feature request, you can open an issue on the
relevant GitHub repository:

- [Modus](https://github.com/hypermodeinc/modus/issues)
- [Hyp CLI](https://github.com/hypermodeinc/hyp-cli/issues)
- [Dgraph](https://github.com/hypermodeinc/dgraph/issues)
- [Badger](https://github.com/hypermodeinc/badger/issues)
- [Hyp CLI](https://github.com/hypermodeinc/hyp-cli/issues)

All paid Hypermode packages include commercial support. Customers can reach out
via the Hypermode Console or through email at
Expand Down
28 changes: 8 additions & 20 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,29 +15,17 @@
"groups": [
{
"group": "Getting Started",
"pages": ["introduction", "quickstart"]
"pages": ["introduction", "semantic-search"]
},
{
"group": "Develop",
"group": "Graphs",
"pages": [
"work-locally",
"deploy",
"configure-environment",
"integrate-api",
"observe-functions"
]
},
{
"group": "Tutorials",
"pages": ["semantic-search"]
},
{
"group": "Manage",
"pages": [
"create-project",
"modify-project",
"modify-organization",
"user-management"
"graphs/overview",
"graphs/deploy",
"graphs/connect",
"graphs/manage-schema",
"graphs/manage-data",
"graphs/manage-graph"
]
},
{
Expand Down
55 changes: 55 additions & 0 deletions graphs/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Connect to Graph
description: Connect to your graph from a SDK, IDE, or Modus
---

## Connection strings

A connection string is a URL that contains all of the necessary information to
connect to your graph from a Dgraph client or Modus. It is displayed after you
deploy your graph.

## Authentication

Your graph endpoint is protected by bearer token authorization passed in the
`Authorization` header as an API key. You can find your API key in the console
alongside your graph connection details. The API key is already included in the
connection string.

<Warning>
If you remove your API key from your graph, it is made publicly accessible
with no authentication.
</Warning>

## Clients

Dgraph includes a web client and language-specific SDKs for programmatically
working with your graph. When using the auto-generated GraphQL API, you can use
any GraphQL client to work with your graph.

### Ratel

Dgraph includes Ratel, a web client for easily connecting to and exploring your
graph. Ratel is available hosted at https://ratel.hypermode.com. To connect to
your graph, paste your connection string into the Ratel interface and click
`Connect`.

### Dgraph SDKs

Dgraph SDKs are available for a number of languages, including
[Go](/dgraph/sdks/go), [Python](/dgraph/sdks/python), [Java](/dgraph/sdks/java),
and [JavaScript](/dgraph/sdks/javascript). The SDKs have been updated to support
the connection string for connecting to your graph on Hypermode. Ensure you're
running the latest version of the SDK for your language.

### GraphQL clients

When working with your graph through the auto-generated GraphQL API, you can use
any [GraphQL IDE or client](/dgraph/graphql/connecting) to connect to your
graph.

### Modus

Modus provides a framework for integrating data from your graph into a complete
AI-ready backend. Learn more on
[connecting Modus to your graph](/modus/data-fetching#dgraph).
12 changes: 12 additions & 0 deletions graphs/deploy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Deploy Graph
description: Deploy a new graph and configure its resources
---

From your workspace home, click `Create new graph`. You are prompted to name
your graph and select the [region](./manage-graph#region-availability) for
deployment. Once deployed, your [connection string](./connect) is displayed.

<Frame>
<img src="/images/graphs/create-graph.png" alt="Create graph" />
</Frame>
39 changes: 39 additions & 0 deletions graphs/manage-data.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Manage Data
description: Query, mutate, and bulk manage data from your graph
---

Querying (reading) and mutating (writing) data to your graph is simple using an
[IDE or SDK](./connect). For bulk operations, there are tools for importing,
exporting, and dropping data.

## Import data

Dgraph provides multiple tools for importing data to your graph, whether an
[initial import to an empty graph](/dgraph/admin/bulk-loader) or an
[incremental import](/dgraph/admin/live-loader).

You can also [load CSV-formatted data](/dgraph/admin/import-csv).

## Export data

If you need to export data from your graph, please reach out to support and we
can assist.

<Note>Self-service for exporting data is coming soon.</Note>

## Drop data

Dropping data from your graph is a permanent action and can't be undone. To drop
data from your graph, you can use the `/alter` endpoint.

To drop all data from your graph, while maintaining the schema:

```sh
curl -X POST https://<my-database>.hypermode.host/dgraph/alter \
--header "Authorization: Bearer $BEARER_TOKEN" \
--header "Content-Type: application/json" \
--data '{"drop_op": "DATA"}'
```

For more options, see [Dgraph's documentation](/dgraph/admin/drop-data).
60 changes: 60 additions & 0 deletions graphs/manage-graph.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: Manage Graph
description: Manage your graph's resources and configuration
---

## Region availability

Graphs on Hypermode are available in the following regions:

| Region | Location |
| :----- | :-------------------- |
| `iad1` | Washington, D.C., USA |
| `pdx1` | Portland, Oregon, USA |

Additional regions are planned to be available in the near future:

- Frankfurt, Germany
- Dublin, Ireland
- Singapore

## Scaling

Graph compute is measured in gigabytes (GB) of memory, with 1 vCPU allocated per
4 gigabytes of memory. On Hypermode, you're charged for the compute allocated to
your graph, billed to the second. That means when your graph is scaled to zero,
you're only billed for the underlying storage.

### Scale to zero

By default, new graphs scale to zero after five minutes of inactivity. When a
new query or mutation is received, the graph scales up and process that request.

You can configure the scaling behavior for your graph by increasing the idle
period. Set the idle period to `0` to turn off scale to zero.

### Autoscaling

Autoscaling is a feature that automatically scales your graph based on the
compute and memory load. When under sustained load, the graph scales up to
handle the additional load. When the load subsides, the graph scales down
automatically.

You can configure the autoscaling behavior for your graph by setting the `min`
and `max` values. The `min` value is the minimum number of compute units the
graph has, and the `max` value is the maximum number of compute units the graph
can scale to.

### Storage

You are billed only for the storage used by your graph. The storage is
automatically provisioned and expanded based on the growth of data within your
graph.

## Backups

Your graph on Hypermode is automatically backed up every four hours, with
backups stored with zonal isolation. To restore your graph to a previous state,
please reach out to support via the console.

<Note>User control of backup frequency and restore is coming soon.</Note>
43 changes: 43 additions & 0 deletions graphs/manage-schema.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Manage Schema
description: Load and update the schema of your graph
---

When working with Dgraph, defining a schema is optional! Start schema-less and
layer on a DQL or GraphQL-based modeling approach when needed.

## Schema-less default

Graphs running in Hypermode use Dgraph's `flexible` schema mode. This mode
allows you to run a mutation without declaring the predicate in your schema.

When a mutation introduces a new predicate, Dgraph automatically adds it to the
schema. This can be useful when you're in the early stages of a project and the
schema is evolving frequently and for allowing AI agents to augment your
knowledge graph.

## Deploy a DQL schema

To deploy a [DQL schema](/dgraph/dql/schema), place the schema in a file
(`schema.dql` in this case) and make a POST request to the `/dgraph/alter`
endpoint for your host.

```sh
curl -X POST https://<my-database>.hypermode.host/dgraph/alter \
--header "Authorization: Bearer $BEARER_TOKEN" \
--header "Content-Type: application/json" \
--data-binary "@schema.dql"
```

## Deploy a GraphQL schema

To deploy a [GraphQL schema](/dgraph/graphql/schema), place the schema in a file
(`schema.graphql` in this case) and make a POST request to the
`/dgraph/admin/schema` endpoint for your host.

```sh
curl -X POST https://<my-database>.hypermode.host/dgraph/admin/schema \
--header "Authorization: Bearer $BEARER_TOKEN" \
--header "Content-Type: application/json" \
--data-binary "@schema.graphql"
```
57 changes: 57 additions & 0 deletions graphs/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: Graphs
description: A fully managed graph database service powered by Dgraph
mode: "wide"
sidebarTitle: Overview
---

Graphs on Hypermode provides a fully managed [Dgraph](/dgraph) service for
building and deploying knowledge graphs. This service combines the power of
Dgraph's distributed graph database with Hypermode's AI development platform,
offering a seamless experience for developers and organizations of all sizes.

## Key features

| Feature | Description |
| :-------------------------------------------------------- | :------------------------------------------------------------------------------- |
| [Scale to Zero](./manage-graph#scale-to-zero) | automatically scale down after periods of inactivity and scale back up on demand |
| [Autoscaling](./manage-graph#autoscaling) | dynamic resource allocation based on workload demands |
| [Flexible Schema Options](./manage-schema) | start schema-less or define structured schemas using DQL or GraphQL |
| [Regional Deployment](./manage-graph#region-availability) | deploy in multiple regions for low-latency access |
| [Modus Integration](/modus/data-fetching#dgraph) | seamlessly integrate with Hypermode's Modus framework for AI-ready backends |
| [Fully Managed Service](./manage-graph) | deploy, scale, and operate your graph database without infrastructure headaches |

## Getting started

To get started with Graphs on Hypermode:

1. **[Deploy a new graph](./deploy)**: create your graph database
2. **[Connect to your graph](./connect)**: use connection strings to access your
graph from various clients
3. **[Manage your schema](./manage-schema)**: define your graph structure using
DQL or GraphQL _(optional)_
4. **[Manage data](./manage-data)**: add, query, and manipulate data in your
graph

## Use cases

Graphs on Hypermode is ideal for:

- Knowledge graphs for AI apps
- Social networks and recommendation systems
- Fraud detection and pattern recognition
- Content management systems with rich interconnections
- Complex relationship modeling
- Any app requiring efficient traversal of connected data

## Why Graphs on Hypermode?

Traditional data stores struggle with highly connected data and complex
relationship queries, which are often found in knowledge graphs. Graph stores
like Dgraph excel at modeling and querying relationships, making them perfect
for building with AI services, where connections between data points are as
important as the data itself.

Hypermode's managed service eliminates the operational complexity of running
Dgraph, allowing you to focus on building your app while we handle scaling,
backups, and infrastructure management.
12 changes: 6 additions & 6 deletions hosted-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ description: "Iterate quickly with seamless access to the most popular models"
---

Hypermode includes a set of shared models available for integration into your
app on a pay-per-token basis.
app.

Need a bespoke model? You can include a model from
[Hugging Face](https://huggingface.co/) in your
[app manifest](/modus/app-manifest) and Hypermode runs and manages it for you.

## Setup

To use a Hypermode-hosted model, set `connection: "hypermode"`,
`provider: "hugging-face"`, and set `sourceModel` to be the model name as
specified on Hugging Face.
To use a Hypermode-hosted model, in your [app manifest](/modus/app-manifest) set
`connection: "hypermode"`, `provider: "hugging-face"`, and set `sourceModel` to
be the model name as specified on Hugging Face.

```json modus.json {3-7}
{
Expand All @@ -32,8 +32,8 @@ specified on Hugging Face.

## Deployment mode

We run our most popular models as multi-tenant, shared instances across projects
and customers.
We run our most popular models as multi-tenant, shared instances across
workspaces and customers.

By default, if the model you use is available as a shared model, your app uses
these shared models at runtime. If the model you use isn't available as a shared
Expand Down
14 changes: 10 additions & 4 deletions hyp-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: Hyp CLI
description: "Comprehensive reference for the Hyp CLI commands and usage"
---

Hyp CLI is a command-line tool for managing your Hypermode account and projects.
When using Hyp CLI alongside the Modus CLI, users get access to
[Hypermode-hosted models](/hosted-models).
Hyp CLI is a command-line tool for managing your Hypermode account and apps.
When using Hyp CLI alongside the Modus CLI, your apps automatically connect to
[Hypermode-hosted models](/hosted-models) when working locally.

## Install

Expand All @@ -20,14 +20,20 @@ npm install -g @hypermode/hyp-cli
### `login`

Log in to your Hypermode account. When executed, this command redirects to the
Hypermode website to authenticate. It stores an authentication token locally and
Hypermode console to authenticate. It stores an authentication token locally and
prompts you to select your organization context.

### `logout`

Log out of your Hypermode account. This command clears your local authentication
token.

### `link`

Link your GitHub repo to a Hypermode project. The command adds a default GitHub
Actions workflow to build your Modus app and a Hypermode GitHub app for
auto-deployment on commit.

### `org switch`

Switch to a different org context within the CLI session.
Binary file added images/graphs/create-graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading