Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
8 changes: 0 additions & 8 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,6 @@

* xref:introspector.adoc[Introspector]

* xref:ogm/index.adoc[]
** xref:ogm/installation.adoc[]
** xref:ogm/directives.adoc[]
** xref:ogm/selection-set.adoc[]
** xref:ogm/type-generation.adoc[]
** xref:ogm/subscriptions.adoc[]
** xref:ogm/reference.adoc[]

* *Frameworks and integrations*

* xref:integrations/apollo-federation.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/directives/custom-logic.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Custom logic
:page-aliases: type-definitions/cypher.adoc, type-definitions/default-values.adoc, ogm/examples/custom-resolvers.adoc, custom-resolvers.adoc
:page-aliases: type-definitions/cypher.adoc, type-definitions/default-values.adoc, custom-resolvers.adoc
:description: This page describes how to use directives for custom logic.

== `@cypher`
Expand Down
11 changes: 0 additions & 11 deletions modules/ROOT/pages/directives/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -140,17 +140,6 @@ of any required fields that is passed as arguments to the custom resolver.

|===

== OGM

[cols="2,5"]
|===
| Directive | Description

| xref::ogm/directives.adoc#_private[`@private`]
| Protects fields which should only be available through the xref::ogm/index.adoc[OGM].

|===

== Relay

[cols="2,5"]
Expand Down
47 changes: 2 additions & 45 deletions modules/ROOT/pages/driver-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This page describes the configuration of the Neo4j GraphQL Library driver.

== Neo4j Driver

For the Neo4j GraphQL Library to work, either an instance of the https://github.com/neo4j/neo4j-javascript-driver[Neo4j JavaScript driver] must be passed in on construction of your `Neo4jGraphQL` instance (or alternatively, `OGM`), or a driver, session or transaction passed into the `context.executionContext` per request.
For the Neo4j GraphQL Library to work, either an instance of the https://github.com/neo4j/neo4j-javascript-driver[Neo4j JavaScript driver] must be passed in on construction of your `Neo4jGraphQL` instance, or a driver, session or transaction passed into the `context.executionContext` per request.

The examples in this page assume a Neo4j database running at "bolt://localhost:7687" with a username of "username" and a password of "password".

Expand Down Expand Up @@ -143,31 +143,10 @@ await startStandaloneServer(server, {

----

=== OGM

[source, javascript, indent=0]
----
import { OGM } from "@neo4j/graphql-ogm";
import neo4j from "neo4j-driver";

const typeDefs = `#graphql
type User {
name: String
}
`;

const driver = neo4j.driver(
"bolt://localhost:7687",
neo4j.auth.basic("username", "password")
);

const ogm = new OGM({ typeDefs, driver });
----

[[driver-configuration-database-compatibility]]
== Database compatibility

Use the `checkNeo4jCompat` method available on either a `Neo4jGraphQL` or `OGM` instance to ensure the specified DBMS is of the required version, and has the necessary functions and procedures available.
Use the `checkNeo4jCompat` method available on a `Neo4jGraphQL` instance to ensure the specified DBMS is of the required version, and has the necessary functions and procedures available.
The `checkNeo4jCompat` throws an `Error` if the DBMS is incompatible, with details of the incompatibilities.

=== `Neo4jGraphQL`
Expand All @@ -192,28 +171,6 @@ const neoSchema = new Neo4jGraphQL({ typeDefs, driver });
await neoSchema.checkNeo4jCompat();
----

=== `OGM`

[source, javascript, indent=0]
----
import { OGM } from "@neo4j/graphql-ogm";
import neo4j from "neo4j-driver";

const typeDefs = `#graphql
type User {
name: String
}
`;

const driver = neo4j.driver(
"bolt://localhost:7687",
neo4j.auth.basic("username", "password")
);

const ogm = new OGM({ typeDefs, driver });
await ogm.checkNeo4jCompat();
----

== Specifying the Neo4j database

Specify the database to be used within your DBMS via the `database` field under `sessionConfig` in the `context` that all resolvers share.
Expand Down
1 change: 0 additions & 1 deletion modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ For every query and mutation that is executed against this generated schema, the
- Options for xref::/directives/database-mapping.adoc[Database mapping] and value xref::/directives/autogeneration.adoc[Autogeneration].
- xref::/queries-aggregations/pagination/index.adoc[Pagination] options.
- xref::/security/index.adoc[Security options] and additional xref::schema-configuration/index.adoc[Schema Configuration].
- An xref::ogm/index.adoc[OGM] (Object Graph Mapper) for programmatic interaction with your GraphQL API.
- A xref::getting-started/toolbox.adoc[Toolbox] (UI) to experiment with your Neo4j GraphQL API on Neo4j Desktop.


Expand Down
85 changes: 0 additions & 85 deletions modules/ROOT/pages/ogm/directives.adoc

This file was deleted.

20 changes: 0 additions & 20 deletions modules/ROOT/pages/ogm/index.adoc

This file was deleted.

Loading