You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api/v4/connectors/cosmosdb.md
+53-48Lines changed: 53 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,12 @@
2
2
3
3
This connector simplifies accessing [Azure CosmosDB](https://azure.microsoft.com/products/cosmos-db/) databases.
4
4
It supports the following .NET drivers:
5
-
-[Microsoft.Azure.Cosmos](https://www.nuget.org/packages/Microsoft.Azure.Cosmos), which provides a `CosmosClient`.
6
5
7
-
The remainder of this page assumes you're familiar with the [basic concepts of Steeltoe Connectors](./usage.md).
6
+
-[Microsoft.Azure.Cosmos](https://www.nuget.org/packages/Microsoft.Azure.Cosmos), which provides a `CosmosClient`
8
7
9
-
## Usage
8
+
The remainder of this topic assumes that you are familiar with the basic concepts of Steeltoe Connectors. See [Overview](./usage.md) for more information.
9
+
10
+
## Using the CosmosDB connector
10
11
11
12
To use this connector:
12
13
@@ -24,7 +25,7 @@ Also add a NuGet reference to one of the .NET drivers listed above, as you would
24
25
25
26
### Configure connection string
26
27
27
-
The CosmosDB connection string can be obtained as described [here](https://learn.microsoft.com/azure/cosmos-db/nosql/how-to-dotnet-get-started#retrieve-your-account-connection-string).
28
+
The CosmosDB connection string can be obtained as described in the [Microsoft documentation](https://learn.microsoft.com/azure/cosmos-db/nosql/how-to-dotnet-get-started#retrieve-your-account-connection-string).
28
29
29
30
The following example `appsettings.json` uses the emulator:
30
31
@@ -43,12 +44,12 @@ The following example `appsettings.json` uses the emulator:
43
44
}
44
45
```
45
46
46
-
Notice this configuration file contains the database name, in addition to the connection string. This value is exposed
47
+
Notice that this configuration file contains the database name, in addition to the connection string. This value is exposed
47
48
as `CosmosDbOptions.Database`.
48
49
49
50
### Initialize Steeltoe Connector
50
51
51
-
Update your `Program.cs`as below to initialize the Connector:
52
+
Update your `Program.cs` to initialize the Connector:
52
53
53
54
```csharp
54
55
usingSteeltoe.Connectors.CosmosDb;
@@ -59,71 +60,75 @@ builder.AddCosmosDb();
59
60
60
61
### Use CosmosClient
61
62
62
-
Start by defining a class that contains container data:
63
-
```csharp
64
-
usingNewtonsoft.Json;
63
+
Follow this procedure:
65
64
66
-
publicclassSampleObject
67
-
{
68
-
[JsonProperty(PropertyName="id")]
69
-
publicstringId { get; set; }
65
+
1. Define a class that contains container data:
70
66
71
-
publicstring? Text { get; set; }
72
-
}
73
-
```
67
+
```csharp
68
+
usingNewtonsoft.Json;
74
69
75
-
To obtain a `CosmosClient` instance in your application, inject the Steeltoe factory in a controller or view:
Copy file name to clipboardExpand all lines: api/v4/connectors/mongodb.md
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,12 @@
2
2
3
3
This connector simplifies accessing [MongoDB](https://www.mongodb.com/) databases.
4
4
It supports the following .NET drivers:
5
-
-[MongoDB.Driver](https://www.nuget.org/packages/MongoDB.Driver), which provides an `IMongoClient`.
6
5
7
-
The remainder of this page assumes you're familiar with the [basic concepts of Steeltoe Connectors](./usage.md).
6
+
-[MongoDB.Driver](https://www.nuget.org/packages/MongoDB.Driver), which provides an `IMongoClient`
8
7
9
-
## Usage
8
+
The remainder of this topic assumes that you are familiar with the basic concepts of Steeltoe Connectors. See [Overview](./usage.md) for more information.
9
+
10
+
## Using the MongoDB connector
10
11
11
12
To use this connector:
12
13
@@ -24,9 +25,9 @@ Also add a NuGet reference to one of the .NET drivers listed above, as you would
24
25
25
26
### Configure connection string
26
27
27
-
The available connection string parameters for MongoDB are documented [here](https://www.mongodb.com/docs/manual/reference/connection-string/).
28
+
The available connection string parameters for MongoDB are described in the [MongoDB documentation](https://www.mongodb.com/docs/manual/reference/connection-string/).
28
29
29
-
The following example `appsettings.json` uses the docker container from above:
30
+
The following example `appsettings.json` uses the docker container used earlier:
30
31
31
32
```json
32
33
{
@@ -43,12 +44,12 @@ The following example `appsettings.json` uses the docker container from above:
43
44
}
44
45
```
45
46
46
-
Notice this configuration file contains the database name, in addition to the connection string. This value is exposed
47
+
Notice that this configuration file contains the database name, in addition to the connection string. This value is exposed
47
48
as `MongoDbOptions.Database`.
48
49
49
50
### Initialize Steeltoe Connector
50
51
51
-
Update your `Program.cs`as below to initialize the Connector:
52
+
Update your `Program.cs` to initialize the Connector:
52
53
53
54
```csharp
54
55
usingSteeltoe.Connectors.MongoDb;
@@ -101,7 +102,8 @@ A complete sample app that uses `IMongoClient` is provided at https://github.com
101
102
## Cloud Foundry
102
103
103
104
This Connector supports the following service brokers:
104
-
-[VMware Tanzu Cloud Service Broker for Azure](https://docs.vmware.com/en/Tanzu-Cloud-Service-Broker-for-Azure/1.4/csb-azure/GUID-index.html)
105
+
106
+
-[VMware Tanzu Cloud Service Broker for Azure](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform-services/tanzu-cloud-service-broker-for-microsoft-azure/1-12/csb-azure/index.html)
105
107
106
108
You can create and bind an instance to your application by using the Cloud Foundry CLI:
107
109
@@ -119,6 +121,6 @@ cf restage myApp
119
121
## Kubernetes
120
122
121
123
This Connector supports the [Service Binding Specification for Kubernetes](https://github.com/servicebinding/spec).
122
-
It can be used through the Bitnami [Services Toolkit](https://docs.vmware.com/en/VMware-Tanzu-Application-Platform/1.5/tap/services-toolkit-install-services-toolkit.html).
124
+
It can be used through the [Services Toolkit](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/services-toolkit-install-services-toolkit.html).
123
125
124
-
For details on how to use this, see the instructions at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/MongoDb#running-on-tanzu-application-platform-tap.
126
+
For details on how to use this, see the instructions at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/MongoDb#running-on-tanzu-platform-for-kubernetes.
Copy file name to clipboardExpand all lines: api/v4/connectors/mysql.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ It supports the following .NET drivers:
8
8
-[Pomelo.EntityFrameworkCore.MySql](https://www.nuget.org/packages/Pomelo.EntityFrameworkCore.MySql), which provides [Entity Framework Core](https://learn.microsoft.com/ef/core) support
9
9
-[MySql.EntityFrameworkCore](https://www.nuget.org/packages/MySql.EntityFrameworkCore), which provides [Entity Framework Core](https://learn.microsoft.com/ef/core) support
10
10
11
-
The remainder of this page assumes that you are familiar with the basic concepts of Steeltoe Connectors. See [Overview](./usage.md).
11
+
The remainder of this topic assumes that you are familiar with the basic concepts of Steeltoe Connectors. See [Overview](./usage.md).
12
12
13
13
## Using the MySQL connector
14
14
@@ -152,6 +152,7 @@ A complete sample app that uses Entity Framework Core with MySQL is provided at
Copy file name to clipboardExpand all lines: api/v4/connectors/rabbitmq.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ It supports the following .NET drivers:
5
5
6
6
-[RabbitMQ.Client](https://www.nuget.org/packages/RabbitMQ.Client), which provides an `IConnection`.
7
7
8
-
The remainder of this page assumes that you are familiar with the basic concepts of Steeltoe Connectors. See [Overview](./usage.md) for more information.
8
+
The remainder of this topic assumes that you are familiar with the basic concepts of Steeltoe Connectors. See [Overview](./usage.md) for more information.
9
9
10
10
## Using the RabbitMQ connector
11
11
@@ -107,6 +107,6 @@ cf restage myApp
107
107
## Kubernetes
108
108
109
109
This Connector supports the [Service Binding Specification for Kubernetes](https://github.com/servicebinding/spec).
110
-
It can be used through the Bitnami [Services Toolkit](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/services-toolkit-install-services-toolkit.html).
110
+
It can be used through the [Services Toolkit](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/services-toolkit-install-services-toolkit.html).
111
111
112
112
For details on how to use this, see the instructions at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/RabbitMQ#running-on-tanzu-platform-for-kubernetes.
Copy file name to clipboardExpand all lines: api/v4/connectors/redis.md
+16-14Lines changed: 16 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,12 @@ This connector simplifies accessing [Redis](https://redis.io/) databases.
7
7
8
8
It supports the following .NET drivers:
9
9
10
-
-[StackExchange.Redis](https://www.nuget.org/packages/StackExchange.Redis), which provides an `IConnectionMultiplexer`.
11
-
-[Microsoft.Extensions.Caching.StackExchangeRedis](https://www.nuget.org/packages/Microsoft.Extensions.Caching.StackExchangeRedis), which provides an `IDistributedCache`.
10
+
-[StackExchange.Redis](https://www.nuget.org/packages/StackExchange.Redis), which provides an `IConnectionMultiplexer`
11
+
-[Microsoft.Extensions.Caching.StackExchangeRedis](https://www.nuget.org/packages/Microsoft.Extensions.Caching.StackExchangeRedis), which provides an `IDistributedCache`
12
12
13
-
The remainder of this page assumes you're familiar with the [basic concepts of Steeltoe Connectors](./usage.md).
13
+
The remainder of this topic assumes that you are familiar with the basic concepts of Steeltoe Connectors. See [Overview](./usage.md) for more information.
14
14
15
-
## Usage
15
+
## Using the Redis Connector
16
16
17
17
To use this connector:
18
18
@@ -30,9 +30,9 @@ Also add a NuGet reference to one of the .NET drivers listed above, as you would
30
30
31
31
### Configure connection string
32
32
33
-
The available connection string parameters for Redis are documented [here](https://stackexchange.github.io/StackExchange.Redis/Configuration.html).
33
+
The available connection string parameters for Redis are described in [StackExchange.Redis](https://stackexchange.github.io/StackExchange.Redis/Configuration.html).
34
34
35
-
The following example `appsettings.json` uses the docker container from above:
35
+
The following example `appsettings.json` uses the docker container used earlier:
36
36
37
37
```json
38
38
{
@@ -50,7 +50,7 @@ The following example `appsettings.json` uses the docker container from above:
50
50
51
51
### Initialize Steeltoe Connector
52
52
53
-
Update your `Program.cs`as below to initialize the Connector:
53
+
Update your `Program.cs` to initialize the Connector:
54
54
55
55
```csharp
56
56
usingSteeltoe.Connectors.Redis;
@@ -86,7 +86,7 @@ public class HomeController : Controller
86
86
}
87
87
```
88
88
89
-
A complete sample app that uses `IConnectionMultiplexer` is provided athttps://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/Redis.
89
+
For a complete sample app that uses `IConnectionMultiplexer`, seehttps://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/Redis.
90
90
91
91
### Use IDistributedCache
92
92
@@ -114,14 +114,16 @@ public class HomeController : Controller
114
114
}
115
115
```
116
116
117
-
A complete sample app that uses `IDistributedCache` is provided athttps://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/Redis.
117
+
For a complete sample app that uses `IDistributedCache`, seehttps://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/Redis.
118
118
119
119
## Cloud Foundry
120
120
121
121
This Connector supports the following service brokers:
122
-
-[Redis for VMware Tanzu Application Service](https://docs.vmware.com/en/Redis-for-VMware-Tanzu-Application-Service/3.1/redis-tanzu-application-service/GUID-index.html)
123
-
-[VMware Tanzu Cloud Service Broker for Azure](https://docs.vmware.com/en/Tanzu-Cloud-Service-Broker-for-Azure/1.4/csb-azure/GUID-index.html)
124
-
-[VMware Tanzu Cloud Service Broker for GCP](https://docs.vmware.com/en/Tanzu-Cloud-Service-Broker-for-GCP/1.2/csb-gcp/GUID-index.html)
122
+
123
+
-[Redis for VMware Tanzu Application Service](https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/redis-for-tanzu-application-service/3-5/redis-for-tas/index.html)
124
+
-[Tanzu for Valkey on Cloud Foundry](https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-for-valkey-on-cloud-foundry/4-0/valkey-on-cf/index.html)
125
+
-[VMware Tanzu Cloud Service Broker for Azure](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform-services/tanzu-cloud-service-broker-for-gcp/1-8/csb-gcp/index.html)
126
+
-[VMware Tanzu Cloud Service Broker for GCP](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform-services/tanzu-cloud-service-broker-for-gcp/1-8/csb-gcp/index.html)
125
127
126
128
You can create and bind an instance to your application by using the Cloud Foundry CLI:
127
129
@@ -139,6 +141,6 @@ cf restage myApp
139
141
## Kubernetes
140
142
141
143
This Connector supports the [Service Binding Specification for Kubernetes](https://github.com/servicebinding/spec).
142
-
It can be used through the Bitnami [Services Toolkit](https://docs.vmware.com/en/VMware-Tanzu-Application-Platform/1.5/tap/services-toolkit-install-services-toolkit.html).
144
+
It can be used through the [Services Toolkit](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/services-toolkit-install-services-toolkit.html).
143
145
144
-
For details on how to use this, see the instructions at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/Redis#running-on-tanzu-application-platform-tap.
146
+
For details on how to use this, see the instructions at https://github.com/SteeltoeOSS/Samples/tree/main/Connectors/src/Redis#running-on-tanzu-platform-for-kubernetes.
0 commit comments