-
Notifications
You must be signed in to change notification settings - Fork 256
/
Database.xml
173 lines (173 loc) · 8.46 KB
/
Database.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<Type Name="Database" FullName="Microsoft.Azure.Documents.Database">
<TypeSignature Language="C#" Value="public class Database : Microsoft.Azure.Documents.Resource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Database extends Microsoft.Azure.Documents.Resource" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Database" />
<TypeSignature Language="VB.NET" Value="Public Class Database
Inherits Resource" />
<TypeSignature Language="F#" Value="type Database = class
 inherit Resource" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.14.1.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.16.2.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.14.1.0</AssemblyVersion>
<AssemblyVersion>2.15.0.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.16.2.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Documents.Resource</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a database in the Azure Cosmos DB account.
</summary>
<remarks>
Each Azure Cosmos DB database account can have zero or more databases. A database in Azure Cosmos DB is a logical container for
document collections and users.
Refer to <see>http://azure.microsoft.com/documentation/articles/documentdb-resources/#databases</see> for more details on databases.
</remarks>
<altmember cref="T:Microsoft.Azure.Documents.DocumentCollection" />
<example>
The example below creates a new Database with an Id property of 'MyDatabase'.
<code language="c#"><![CDATA[
using (DocumentClient client = new DocumentClient(new Uri("service endpoint"), "auth key"))
{
Database db = await client.CreateDatabaseAsync(new Database { Id = "MyDatabase" });
}
]]></code></example>
<example>
The example below creates a collection within this database with OfferThroughput set to 10000.
<code language="c#"><![CDATA[
DocumentCollection coll = await client.CreateDocumentCollectionAsync(db.SelfLink,
new DocumentCollection { Id = "MyCollection" },
new RequestOptions { OfferThroughput = 10000} );
]]></code></example>
<example>
The example below queries for a Database by Id to retrieve the SelfLink.
<code language="c#"><![CDATA[
using Microsoft.Azure.Documents.Linq;
Database database = client.CreateDatabaseQuery().Where(d => d.Id == "MyDatabase").AsEnumerable().FirstOrDefault();
string databaseLink = database.SelfLink;
]]></code></example>
<example>
The example below deletes the database using its SelfLink property.
<code language="c#"><![CDATA[
await client.DeleteDatabaseAsync(db.SelfLink);
]]></code></example>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Database ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Database.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.Database" /> class for the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CollectionsLink">
<MemberSignature Language="C#" Value="public string CollectionsLink { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CollectionsLink" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Database.CollectionsLink" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CollectionsLink As String" />
<MemberSignature Language="F#" Value="member this.CollectionsLink : string" Usage="Microsoft.Azure.Documents.Database.CollectionsLink" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="_colls")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="_colls")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the self-link for collections from the Azure Cosmos DB service.
</summary>
<value>
The self-link for collections in the database.
</value>
<remarks>
Every Azure Cosmos DB resource has a static, immutable, addressable URI.
For collections, this takes the form of;
/dbs/db_rid/colls/ where db_rid represents the value of the database's resource id.
A resource id is not the id given to a database on creation, but an internally generated immutable id.
</remarks>
</Docs>
</Member>
<Member MemberName="UsersLink">
<MemberSignature Language="C#" Value="public string UsersLink { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string UsersLink" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Database.UsersLink" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property UsersLink As String" />
<MemberSignature Language="F#" Value="member this.UsersLink : string" Usage="Microsoft.Azure.Documents.Database.UsersLink" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>2.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="_users")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="_users")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the self-link for users from the Azure Cosmos DB service.
</summary>
<value>
The self-link for users in the database.
</value>
<remarks>
Every Azure Cosmos DB resource has a static, immutable, addressable URI.
For users, this takes the form of;
/dbs/db_rid/users/ where db_rid represents the value of the database's resource id.
A resource id is not the id given to a database on creation, but an internally generated immutable id.
</remarks>
</Docs>
</Member>
</Members>
</Type>