Skip to content

Commit ea850ed

Browse files
committed
Updating bulk executor terminology
1 parent 020f4ea commit ea850ed

8 files changed

+26
-26
lines changed

articles/cosmos-db/bulk-executor-graph-dotnet.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Using the graph BulkExecutor .NET library to perform bulk operations in Azure Cosmos DB Gremlin API
3-
description: Learn how to use the BulkExecutor library to massively import graph data into an Azure Cosmos DB Gremlin API container.
2+
title: Using the graph bulk executor .NET library to perform bulk operations in Azure Cosmos DB Gremlin API
3+
description: Learn how to use the bulk executor library to massively import graph data into an Azure Cosmos DB Gremlin API container.
44
author: luisbosquez
55
ms.service: cosmos-db
66
ms.subservice: cosmosdb-graph
@@ -10,22 +10,22 @@ ms.author: lbosq
1010
ms.reviewer: sngun
1111
---
1212

13-
# Using the graph BulkExecutor .NET library to perform bulk operations in Azure Cosmos DB Gremlin API
13+
# Using the graph bulk executor .NET library to perform bulk operations in Azure Cosmos DB Gremlin API
1414

15-
This tutorial provides instructions about using Azure CosmosDB's BulkExecutor .NET library to import and update graph objects into an Azure Cosmos DB Gremlin API container. This process makes use of the Graph class in the [BulkExecutor library](https://docs.microsoft.com/azure/cosmos-db/bulk-executor-overview) to create Vertex and Edge objects programmatically to then insert multiple of them per network request. This behavior is configurable through the BulkExecutor library to make optimal use of both database and local memory resources.
15+
This tutorial provides instructions about using Azure CosmosDB's bulk executor .NET library to import and update graph objects into an Azure Cosmos DB Gremlin API container. This process makes use of the Graph class in the [bulk executor library](https://docs.microsoft.com/azure/cosmos-db/bulk-executor-overview) to create Vertex and Edge objects programmatically to then insert multiple of them per network request. This behavior is configurable through the bulk executor library to make optimal use of both database and local memory resources.
1616

17-
As opposed to sending Gremlin queries to a database, where the command is evaluated and then executed one at a time, using the BulkExecutor library will instead require to create and validate the objects locally. After creating the objects, the library allows you to send graph objects to the database service sequentially. Using this method, data ingestion speeds can be increased up to 100x, which makes it an ideal method for initial data migrations or periodical data movement operations. Learn more by visiting the GitHub page of the [Azure Cosmos DB Graph BulkExecutor sample application](https://aka.ms/graph-bulkexecutor-sample).
17+
As opposed to sending Gremlin queries to a database, where the command is evaluated and then executed one at a time, using the bulk executor library will instead require to create and validate the objects locally. After creating the objects, the library allows you to send graph objects to the database service sequentially. Using this method, data ingestion speeds can be increased up to 100x, which makes it an ideal method for initial data migrations or periodical data movement operations. Learn more by visiting the GitHub page of the [Azure Cosmos DB Graph bulk executor sample application](https://aka.ms/graph-bulkexecutor-sample).
1818

1919
## Bulk operations with graph data
2020

21-
The [BulkExecutor library](https://docs.microsoft.com/dotnet/api/microsoft.azure.cosmosdb.bulkexecutor.graph?view=azure-dotnet) contains a `Microsoft.Azure.CosmosDB.BulkExecutor.Graph` namespace to provide functionality for creating and importing graph objects.
21+
The [bulk executor library](https://docs.microsoft.com/dotnet/api/microsoft.azure.cosmosdb.bulkexecutor.graph?view=azure-dotnet) contains a `Microsoft.Azure.CosmosDB.BulkExecutor.Graph` namespace to provide functionality for creating and importing graph objects.
2222

2323
The following process outlines how data migration can be used for a Gremlin API container:
2424
1. Retrieve records from the data source.
2525
2. Construct `GremlinVertex` and `GremlinEdge` objects from the obtained records and add them into an `IEnumerable` data structure. In this part of the application the logic to detect and add relationships should be implemented, in case the data source is not a graph database.
2626
3. Use the [Graph BulkImportAsync method](https://docs.microsoft.com/dotnet/api/microsoft.azure.cosmosdb.bulkexecutor.graph.graphbulkexecutor.bulkimportasync?view=azure-dotnet) to insert the graph objects into the collection.
2727

28-
This mechanism will improve the data migration efficiency as compared to using a Gremlin client. This improvement is experienced because inserting data with Gremlin will require the application send a query at a time that will need to be validated, evaluated, and then executed to create the data. The BulkExecutor library will handle the validation in the application and send multiple graph objects at a time for each network request.
28+
This mechanism will improve the data migration efficiency as compared to using a Gremlin client. This improvement is experienced because inserting data with Gremlin will require the application send a query at a time that will need to be validated, evaluated, and then executed to create the data. The bulk executor library will handle the validation in the application and send multiple graph objects at a time for each network request.
2929

3030
### Creating Vertices and Edges
3131

@@ -68,7 +68,7 @@ catch (Exception e)
6868
}
6969
```
7070

71-
For more information on the parameters of the BulkExecutor library, refer to the [BulkImportData to Azure Cosmos DB topic](https://docs.microsoft.com/azure/cosmos-db/bulk-executor-dot-net#bulk-import-data-to-azure-cosmos-db).
71+
For more information on the parameters of the bulk executor library, refer to the [BulkImportData to Azure Cosmos DB topic](https://docs.microsoft.com/azure/cosmos-db/bulk-executor-dot-net#bulk-import-data-to-azure-cosmos-db).
7272

7373
The payload needs to be instantiated into `GremlinVertex` and `GremlinEdge` objects. Here is how these objects can be created:
7474

@@ -104,7 +104,7 @@ e.AddProperty("customProperty", "value");
104104
```
105105

106106
> [!NOTE]
107-
> The BulkExecutor utility doesn't automatically check for existing Vertices before adding Edges. This needs to be validated in the application before running the BulkImport tasks.
107+
> The bulk executor utility doesn't automatically check for existing Vertices before adding Edges. This needs to be validated in the application before running the BulkImport tasks.
108108
109109
## Sample application
110110

@@ -115,7 +115,7 @@ e.AddProperty("customProperty", "value");
115115
* Git. For more information check out the [Git Downloads page](https://git-scm.com/downloads).
116116

117117
### Clone the sample application
118-
In this tutorial, we'll follow through the steps for getting started by using the [Azure Cosmos DB Graph BulkExecutor sample](https://aka.ms/graph-bulkexecutor-sample) hosted on GitHub. This application consists of a .NET solution that randomly generates vertex and edge objects and then executes bulk insertions to the specified graph database account. To get the application, run the `git clone` command below:
118+
In this tutorial, we'll follow through the steps for getting started by using the [Azure Cosmos DB Graph bulk executor sample](https://aka.ms/graph-bulkexecutor-sample) hosted on GitHub. This application consists of a .NET solution that randomly generates vertex and edge objects and then executes bulk insertions to the specified graph database account. To get the application, run the `git clone` command below:
119119

120120
```bash
121121
git clone https://github.com/Azure-Samples/azure-cosmosdb-graph-bulkexecutor-dotnet-getting-started.git
@@ -126,7 +126,7 @@ This repository contains the GraphBulkExecutor sample with the following files:
126126
File|Description
127127
---|---
128128
`App.config`|This is where the application and database-specific parameters are specified. This file should be modified first to connect to the destination database and collections.
129-
`Program.cs`| This file contains the logic behind creating the `DocumentClient` collection, handling the cleanups and sending the BulkExecutor requests.
129+
`Program.cs`| This file contains the logic behind creating the `DocumentClient` collection, handling the cleanups and sending the bulk executor requests.
130130
`Util.cs`| This file contains a helper class that contains the logic behind generating test data, and checking if the database and collections exist.
131131

132132
In the `App.config` file, the following are the configuration values that can be provided:
@@ -151,5 +151,5 @@ Setting|Description
151151

152152
## Next steps
153153
* To learn about Nuget package details and release notes of bulk executor .NET library, see [bulk executor SDK details](sql-api-sdk-bulk-executor-dot-net.md).
154-
* Check out the [Performance Tips](https://docs.microsoft.com/azure/cosmos-db/bulk-executor-dot-net#performance-tips) to further optimize the usage of BulkExecutor.
154+
* Check out the [Performance Tips](https://docs.microsoft.com/azure/cosmos-db/bulk-executor-dot-net#performance-tips) to further optimize the usage of bulk executor.
155155
* Review the [BulkExecutor.Graph Reference article](https://docs.microsoft.com/dotnet/api/microsoft.azure.cosmosdb.bulkexecutor.graph?view=azure-dotnet) for more details about the classes and methods defined in this namespace.

articles/cosmos-db/graph-modeling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Edge objects have a default direction that is followed by a traversal when using
8989

9090
However, traversing in the opposite direction of an edge, using the `in()` function, will always result in a cross-partition query. Learn more about [graph partitioning](graph-partitioning.md). If there's a need to constantly traverse using the `in()` function, it's recommended to add edges in both directions.
9191

92-
You can determine the edge direction by using the `.to()` or `.from()` predicates to the `.addE()` Gremlin step. Or by using the [BulkExecutor library for Gremlin API](bulk-executor-graph-dotnet.md).
92+
You can determine the edge direction by using the `.to()` or `.from()` predicates to the `.addE()` Gremlin step. Or by using the [bulk executor library for Gremlin API](bulk-executor-graph-dotnet.md).
9393

9494
> [!NOTE]
9595
> Edge objects have a direction by default.

articles/cosmos-db/migrate-cosmosdb-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ After the prerequisites are completed, you can migrate data with the following s
126126

127127
1. First import the data from source to Azure Blob Storage. To increase the speed of migration, it is helpful to parallelize across distinct source partitions. Before starting the migration, the source data set should be partitioned into files with size around 200 MB size.
128128

129-
2. The Bulk executor library can scale up, to consume 500,000 RUs in a single client VM. Since the available throughput is 5 million RUs, 10 Ubuntu 16.04 VMs (Standard_D32_v3) should be provisioned in the same region where your Azure Cosmos database is located. You should prepare these VMs with the migration tool and its settings file.
129+
2. The bulk executor library can scale up, to consume 500,000 RUs in a single client VM. Since the available throughput is 5 million RUs, 10 Ubuntu 16.04 VMs (Standard_D32_v3) should be provisioned in the same region where your Azure Cosmos database is located. You should prepare these VMs with the migration tool and its settings file.
130130

131131
3. Run the queue step on one of the client virtual machines. This step creates the tracking collection, which scans the ADLS container and creates a progress-tracking document for each of the source data set’s partition files.
132132

articles/cosmos-db/sql-api-sdk-async-java.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ ms.author: moderakh
2222
> * [REST](https://docs.microsoft.com/rest/api/cosmos-db/)
2323
> * [REST Resource Provider](https://docs.microsoft.com/rest/api/cosmos-db-resource-provider/)
2424
> * [SQL](sql-api-query-reference.md)
25-
> * [BulkExecutor - .NET](sql-api-sdk-bulk-executor-dot-net.md)
26-
> * [BulkExecutor - Java](sql-api-sdk-bulk-executor-java.md)
25+
> * [Bulk executor - .NET](sql-api-sdk-bulk-executor-dot-net.md)
26+
> * [Bulk executor - Java](sql-api-sdk-bulk-executor-java.md)
2727
2828
The SQL API Async Java SDK differs from the SQL API Java SDK by providing asynchronous operations with support of the [Netty library](https://netty.io/). The pre-existing [SQL API Java SDK](sql-api-sdk-java.md) does not support asynchronous operations.
2929

articles/cosmos-db/sql-api-sdk-bulk-executor-dot-net.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ ms.author: ramkris
3131
|---|---|
3232
| **Description**| The .Net bulk executor library allows client applications to perform bulk operations on Azure Cosmos DB accounts. This library provides BulkImport, BulkUpdate, and BulkDelete namespaces. The BulkImport module can bulk ingest documents in an optimized way such that the throughput provisioned for a collection is consumed to its maximum extent. The BulkUpdate module can bulk update existing data in Azure Cosmos containers as patches. The BulkDelete module can bulk delete documents in an optimized way such that the throughput provisioned for a collection is consumed to its maximum extent.|
3333
|**SDK download**| [NuGet](https://www.nuget.org/packages/Microsoft.Azure.CosmosDB.BulkExecutor/) |
34-
| **BulkExecutor library in GitHub**| [GitHub](https://github.com/Azure/azure-cosmosdb-bulkexecutor-dotnet-getting-started)|
34+
| **Bulk executor library in GitHub**| [GitHub](https://github.com/Azure/azure-cosmosdb-bulkexecutor-dotnet-getting-started)|
3535
|**API documentation**|[.NET API reference documentation](https://docs.microsoft.com/dotnet/api/microsoft.azure.cosmosdb.bulkexecutor?view=azure-dotnet)|
3636
|**Get started**|[Get started with the bulk executor library .NET SDK](bulk-executor-dot-net.md)|
3737
| **Current supported framework**| Microsoft .NET Framework 4.5.2, 4.6.1 and .NET Standard 2.0 |
@@ -56,7 +56,7 @@ ms.author: ramkris
5656

5757
### <a name="2.0.0-preview"/>2.0.0-preview
5858

59-
* Added .NET Standard 2.0 as one of the supported target frameworks to make the BulkExecutor library work with .NET Core applications.
59+
* Added .NET Standard 2.0 as one of the supported target frameworks to make the bulk executor library work with .NET Core applications.
6060

6161
### <a name="1.6.0"/>1.6.0
6262

@@ -76,19 +76,19 @@ ms.author: ramkris
7676

7777
### <a name="1.3.0"/>1.3.0
7878

79-
* Fixed an issue, which caused a formatting issue in the user agent used by BulkExecutor.
79+
* Fixed an issue, which caused a formatting issue in the user agent used by bulk executor.
8080

8181
### <a name="1.2.0"/>1.2.0
8282

83-
* Made improvement to BulkExecutor import and update APIs to transparently adapt to elastic scaling of Cosmos container when storage exceeds current capacity without throwing exceptions.
83+
* Made improvement to bulk executor import and update APIs to transparently adapt to elastic scaling of Cosmos container when storage exceeds current capacity without throwing exceptions.
8484

8585
### <a name="1.1.2"/>1.1.2
8686

8787
* Bumped up the DocumentDB .NET SDK dependency to version 2.1.3.
8888

8989
### <a name="1.1.1"/>1.1.1
9090

91-
* Fixed an issue, which caused BulkExecutor to throw JSRT error while importing to fixed collections.
91+
* Fixed an issue, which caused bulk executor to throw JSRT error while importing to fixed collections.
9292

9393
### <a name="1.1.0"/>1.1.0
9494

articles/cosmos-db/sql-api-sdk-bulk-executor-java.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ ms.author: ramkris
3131
|---|---|
3232
|**Description**|The bulk executor library allows client applications to perform bulk operations in Azure Cosmos DB accounts. bulk executor library provides BulkImport, and BulkUpdate namespaces. The BulkImport module can bulk ingest documents in an optimized way such that the throughput provisioned for a collection is consumed to its maximum extent. The BulkUpdate module can bulk update existing data in Azure Cosmos containers as patches.|
3333
|**SDK download**|[Maven](https://search.maven.org/#search%7Cga%7C1%7Cdocumentdb-bulkexecutor)|
34-
|**BulkExecutor library in GitHub**|[GitHub](https://github.com/Azure/azure-cosmosdb-bulkexecutor-java-getting-started)|
34+
|**Bulk executor library in GitHub**|[GitHub](https://github.com/Azure/azure-cosmosdb-bulkexecutor-java-getting-started)|
3535
| **API documentation**| [.NET API reference documentation](https://docs.microsoft.com/java/api/com.microsoft.azure.documentdb.bulkexecutor)|
3636
|**Get started**|[Get started with the bulk executor library Java SDK](bulk-executor-java.md)|
3737
|**Minimum supported runtime**|[Java Development Kit (JDK) 7+](https://aka.ms/azure-jdks)|

articles/cosmos-db/sql-api-sdk-node.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ ms.author: dech
2323
> * [REST](https://docs.microsoft.com/rest/api/cosmos-db/)
2424
> * [REST Resource Provider](https://docs.microsoft.com/rest/api/cosmos-db-resource-provider/)
2525
> * [SQL](sql-api-query-reference.md)
26-
> * [BulkExecutor - .NET](sql-api-sdk-bulk-executor-dot-net.md)
27-
> * [BulkExecutor - Java](sql-api-sdk-bulk-executor-java.md)
26+
> * [Bulk executor - .NET](sql-api-sdk-bulk-executor-dot-net.md)
27+
> * [Bulk executor - Java](sql-api-sdk-bulk-executor-java.md)
2828
2929
|Resource |Link |
3030
|---------|---------|

articles/cosmos-db/sql-api-sdk-python.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ ms.author: sngun
2323
> * [REST](https://docs.microsoft.com/rest/api/cosmos-db/)
2424
> * [REST Resource Provider](https://docs.microsoft.com/rest/api/cosmos-db-resource-provider/)
2525
> * [SQL](sql-api-query-reference.md)
26-
> * [BulkExecutor - .NET](sql-api-sdk-bulk-executor-dot-net.md)
27-
> * [BulkExecutor - Java](sql-api-sdk-bulk-executor-java.md)
26+
> * [Bulk executor - .NET](sql-api-sdk-bulk-executor-dot-net.md)
27+
> * [Bulk executor - Java](sql-api-sdk-bulk-executor-java.md)
2828
2929
| | |
3030
|---|---|

0 commit comments

Comments
 (0)