Skip to content

Commit 8a37ec2

Browse files
committed
Remove OGM docs
1 parent b22d3d5 commit 8a37ec2

File tree

12 files changed

+3
-1443
lines changed

12 files changed

+3
-1443
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,6 @@
6161
6262
* xref:introspector.adoc[Introspector]
6363
64-
* xref:ogm/index.adoc[]
65-
** xref:ogm/installation.adoc[]
66-
** xref:ogm/directives.adoc[]
67-
** xref:ogm/selection-set.adoc[]
68-
** xref:ogm/type-generation.adoc[]
69-
** xref:ogm/subscriptions.adoc[]
70-
** xref:ogm/reference.adoc[]
71-
7264
* *Frameworks and integrations*
7365
7466
* xref:integrations/apollo-federation.adoc[]

modules/ROOT/pages/directives/custom-logic.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= Custom logic
2-
:page-aliases: type-definitions/cypher.adoc, type-definitions/default-values.adoc, ogm/examples/custom-resolvers.adoc, custom-resolvers.adoc
2+
:page-aliases: type-definitions/cypher.adoc, type-definitions/default-values.adoc, custom-resolvers.adoc
33
:description: This page describes how to use directives for custom logic.
44

55
== `@cypher`

modules/ROOT/pages/directives/index.adoc

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -140,17 +140,6 @@ of any required fields that is passed as arguments to the custom resolver.
140140

141141
|===
142142

143-
== OGM
144-
145-
[cols="2,5"]
146-
|===
147-
| Directive | Description
148-
149-
| xref::ogm/directives.adoc#_private[`@private`]
150-
| Protects fields which should only be available through the xref::ogm/index.adoc[OGM].
151-
152-
|===
153-
154143
== Relay
155144

156145
[cols="2,5"]

modules/ROOT/pages/driver-configuration.adoc

Lines changed: 2 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This page describes the configuration of the Neo4j GraphQL Library driver.
66

77
== Neo4j Driver
88

9-
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.
9+
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.
1010

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

@@ -143,31 +143,10 @@ await startStandaloneServer(server, {
143143
144144
----
145145

146-
=== OGM
147-
148-
[source, javascript, indent=0]
149-
----
150-
import { OGM } from "@neo4j/graphql-ogm";
151-
import neo4j from "neo4j-driver";
152-
153-
const typeDefs = `#graphql
154-
type User {
155-
name: String
156-
}
157-
`;
158-
159-
const driver = neo4j.driver(
160-
"bolt://localhost:7687",
161-
neo4j.auth.basic("username", "password")
162-
);
163-
164-
const ogm = new OGM({ typeDefs, driver });
165-
----
166-
167146
[[driver-configuration-database-compatibility]]
168147
== Database compatibility
169148

170-
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.
149+
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.
171150
The `checkNeo4jCompat` throws an `Error` if the DBMS is incompatible, with details of the incompatibilities.
172151

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

195-
=== `OGM`
196-
197-
[source, javascript, indent=0]
198-
----
199-
import { OGM } from "@neo4j/graphql-ogm";
200-
import neo4j from "neo4j-driver";
201-
202-
const typeDefs = `#graphql
203-
type User {
204-
name: String
205-
}
206-
`;
207-
208-
const driver = neo4j.driver(
209-
"bolt://localhost:7687",
210-
neo4j.auth.basic("username", "password")
211-
);
212-
213-
const ogm = new OGM({ typeDefs, driver });
214-
await ogm.checkNeo4jCompat();
215-
----
216-
217174
== Specifying the Neo4j database
218175

219176
Specify the database to be used within your DBMS via the `database` field under `sessionConfig` in the `context` that all resolvers share.

modules/ROOT/pages/index.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ For every query and mutation that is executed against this generated schema, the
3131
- Options for xref::/directives/database-mapping.adoc[Database mapping] and value xref::/directives/autogeneration.adoc[Autogeneration].
3232
- xref::/queries-aggregations/pagination/index.adoc[Pagination] options.
3333
- xref::/security/index.adoc[Security options] and additional xref::schema-configuration/index.adoc[Schema Configuration].
34-
- An xref::ogm/index.adoc[OGM] (Object Graph Mapper) for programmatic interaction with your GraphQL API.
3534
- A xref::getting-started/toolbox.adoc[Toolbox] (UI) to experiment with your Neo4j GraphQL API on Neo4j Desktop.
3635

3736

modules/ROOT/pages/ogm/directives.adoc

Lines changed: 0 additions & 85 deletions
This file was deleted.

modules/ROOT/pages/ogm/index.adoc

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)