Skip to content

Commit e86c72d

Browse files
Paul-CornellPaul-Cornell
authored
Platform: Neo4j destination connector (#422)
1 parent ea7489a commit e86c72d

File tree

12 files changed

+117
-2
lines changed

12 files changed

+117
-2
lines changed

‎mint.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -507,6 +507,7 @@
507507
"platform/destinations/google-cloud",
508508
"platform/destinations/milvus",
509509
"platform/destinations/mongodb",
510+
"platform/destinations/neo4j",
510511
"platform/destinations/onedrive",
511512
"platform/destinations/pinecone",
512513
"platform/destinations/postgresql",
@@ -555,6 +556,7 @@
555556
"platform/api/destinations/google-cloud",
556557
"platform/api/destinations/milvus",
557558
"platform/api/destinations/mongodb",
559+
"platform/api/destinations/neo4j",
558560
"platform/api/destinations/onedrive",
559561
"platform/api/destinations/pinecone",
560562
"platform/api/destinations/postgresql",

‎platform/api/destinations/neo4j.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Neo4j
3+
---
4+
5+
Send processed data from Unstructured to Neo4j.
6+
7+
The requirements are as follows.
8+
9+
import Neo4jPrerequisites from '/snippets/general-shared-text/neo4j.mdx';
10+
11+
<Neo4jPrerequisites />
12+
13+
To create or change a Neo4j destination connector, see the following examples.
14+
15+
import Neo4jAPIRESTCreate from '/snippets/destination_connectors/neo4j_rest_create.mdx';
16+
import Neo4jAPIRESTChange from '/snippets/destination_connectors/neo4j_rest_change.mdx';
17+
18+
<CodeGroup>
19+
<Neo4jAPIRESTCreate />
20+
<Neo4jAPIRESTChange />
21+
</CodeGroup>
22+
23+
Replace the preceding placeholders as follows:
24+
25+
import Neo4jAPIPlaceholders from '/snippets/general-shared-text/neo4j-api-placeholders.mdx';
26+
27+
<Neo4jAPIPlaceholders />
28+
29+
To change a connector, replace `<connector-id>` with the source connector's unique ID.
30+
To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors).

‎platform/api/destinations/overview.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@ For the list of specific settings, see:
2222
- [Google Cloud Storage](/platform/api/destinations/google-cloud) (`destination_type=gcs`)
2323
- [Milvus](/platform/api/destinations/milvus) (`destination_type=milvus`)
2424
- [MongoDB](/platform/api/destinations/mongodb) (`destination_type=mongodb`)
25+
- [Neo4j](/platform/api/destinations/neo4j) (`destination_type=neo4j`)
2526
- [OneDrive](/platform/api/destinations/onedrive) (`destination_type=onedrive`)
2627
- [Pinecone](/platform/api/destinations/pinecone) (`destination_type=pinecone`)
2728
- [PostgreSQL](/platform/api/destinations/postgresql) (`destination_type=postgres`)
28-
- [Qdrant](/platform/api/destinations/qdrant) (`destination_type=qdrant`)
29+
- [Qdrant](/platform/api/destinations/qdrant) (`destination_type=qdrant-cloud`)
2930
- [S3](/platform/api/destinations/s3) (`destination_type=s3`)
3031
- [Weaviate](/platform/api/destinations/weaviate) (`destination_type=weaviate`)
3132

‎platform/connectors.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ If your source is not listed here, you might still be able to connect Unstructur
4343
- [Google Cloud Storage](/platform/destinations/google-cloud)
4444
- [Milvus](/platform/destinations/milvus)
4545
- [MongoDB](/platform/destinations/mongodb)
46+
- [Neo4j](/platform/destinations/neo4j)
4647
- [OneDrive](/platform/destinations/onedrive)
4748
- [Pinecone](/platform/destinations/pinecone)
4849
- [PostgreSQL](/platform/destinations/postgresql)

‎platform/destinations/neo4j.mdx‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Neo4j
3+
---
4+
5+
Send processed data from Unstructured to Neo4j.
6+
7+
The requirements are as follows.
8+
9+
import Neo4jPrerequisites from '/snippets/general-shared-text/neo4j.mdx';
10+
11+
<Neo4jPrerequisites />
12+
13+
To create the destination connector:
14+
15+
1. On the sidebar, click **Connectors**.
16+
2. Click **Destinations**.
17+
3. Cick **New** or **Create Connector**.
18+
4. Give the connector some unique **Name**.
19+
5. In the **Provider** area, click **Neo4j**.
20+
6. Click **Continue**.
21+
7. Follow the on-screen instructions to fill in the fields as described later on this page.
22+
8. Click **Save and Test**.
23+
24+
import Neo4jFields from '/snippets/general-shared-text/neo4j-platform.mdx';
25+
26+
<Neo4jFields />

‎platform/destinations/overview.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ To create a destination connector:
2626
- [Google Cloud Storage](/platform/destinations/google-cloud)
2727
- [Milvus](/platform/destinations/milvus)
2828
- [MongoDB](/platform/destinations/mongodb)
29+
- [Neo4j](/platform/destinations/neo4j)
2930
- [OneDrive](/platform/destinations/onedrive)
3031
- [Pinecone](/platform/destinations/pinecone)
3132
- [PostgreSQL](/platform/destinations/postgresql)

‎snippets/destination_connectors/neo4j_rest_change.mdx‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
```bash REST (Change)
2+
curl --request 'PUT' --location \
3+
"$UNSTRUCTURED_API_URL/destinations/<connector-id>" \
4+
--header 'accept: application/json' \
5+
--header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
6+
--header 'content-type: application/json' \
7+
--data \
8+
'{
9+
"config": {
10+
"uri": "<uri>",
11+
"database": "<database>",
12+
"username": "<username>",
13+
"password": "<password>",
14+
"batch_size": <batch-size>
15+
}
16+
}'
17+
```

‎snippets/destination_connectors/neo4j_rest_create.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
```bash REST (Create)
2+
curl --request 'POST' --location \
3+
"$UNSTRUCTURED_API_URL/destinations" \
4+
--header 'accept: application/json' \
5+
--header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
6+
--header 'content-type: application/json' \
7+
--data \
8+
'{
9+
"name": "<name>",
10+
"type": "neo4j",
11+
"config": {
12+
"uri": "<uri>",
13+
"database": "<database>",
14+
"username": "<username>",
15+
"password": "<password>",
16+
"batch_size": <batch-size>
17+
}
18+
}'
19+
```

‎snippets/destination_connectors/qdrant_rest_create.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ curl --request 'POST' --location \
77
--data \
88
'{
99
"name": "<name>",
10-
"type": "qdrant",
10+
"type": "qdrant-cloud",
1111
"config": {
1212
"url": "<url>",
1313
"collection_name": "<collection-name>",

‎snippets/general-shared-text/neo4j-api-placeholders.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
- `<name>` (_required_) - A unique name for this connector.
2+
- `<uri>` (_required_) - The connection URI for the Neo4j deployment, which typically starts with `neo4j://`, `neo4j+s://`, `bolt://`, or `bolt+s://`; is followed by the host name; and ends with a colon and the port number (such as `:7473`, `:7474`, or `:7687`).
3+
- `<database>` (_required_) - The name of the target database in the Neo4j deployment. A default Neo4j deployment typically contains a standard database named neo4j for user data.
4+
- `<username>` (_required_) - The name of the user who has access to the Neo4j deployment. A default Neo4j deployment typically contains a default user named `neo4j`.
5+
- `<password>` (_required_) - The password for the user.
6+
- `<batch-size>` - The maximum number of nodes or relationships to be transmitted per batch. The default is `100` if not otherwise specified.

0 commit comments

Comments
 (0)