-
Notifications
You must be signed in to change notification settings - Fork 255
/
DatabaseProperties.xml
186 lines (186 loc) · 9.43 KB
/
DatabaseProperties.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
174
175
176
177
178
179
180
181
182
183
184
185
186
<Type Name="DatabaseProperties" FullName="Azure.Cosmos.DatabaseProperties">
<TypeSignature Language="C#" Value="public class DatabaseProperties" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DatabaseProperties extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Cosmos.DatabaseProperties" />
<TypeSignature Language="VB.NET" Value="Public Class DatabaseProperties" />
<TypeSignature Language="F#" Value="type DatabaseProperties = class" />
<AssemblyInfo>
<AssemblyName>Azure.Cosmos</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonDatabasePropertiesConverter))]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonDatabasePropertiesConverter))>]</AttributeName>
</Attribute>
</Attributes>
<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>
<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" },
10000);
]]></code></example>
<example>
The example below queries for a Database by Id to retrieve the SelfLink.
<code language="c#"><![CDATA[
using Microsoft.Azure.Cosmos.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>
<altmember cref="T:Azure.Cosmos.ContainerProperties" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DatabaseProperties ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Cosmos.DatabaseProperties.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Cosmos</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Azure.Cosmos.DatabaseProperties" /> class for the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DatabaseProperties (string id);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Cosmos.DatabaseProperties.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (id As String)" />
<MemberSignature Language="F#" Value="new Azure.Cosmos.DatabaseProperties : string -> Azure.Cosmos.DatabaseProperties" Usage="new Azure.Cosmos.DatabaseProperties id" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Cosmos</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="id" Type="System.String" />
</Parameters>
<Docs>
<param name="id">The Id of the resource in the Azure Cosmos service.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.Cosmos.DatabaseProperties" /> class for the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ETag">
<MemberSignature Language="C#" Value="public Azure.ETag? ETag { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.ETag> ETag" />
<MemberSignature Language="DocId" Value="P:Azure.Cosmos.DatabaseProperties.ETag" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ETag As Nullable(Of ETag)" />
<MemberSignature Language="F#" Value="member this.ETag : Nullable<Azure.ETag>" Usage="Azure.Cosmos.DatabaseProperties.ETag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Cosmos</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.ETag></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the entity tag associated with the resource from the Azure Cosmos DB service.
</summary>
<value>
The entity tag associated with the resource.
</value>
<remarks>
ETags are used for concurrency checking when updating resources.
</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Azure.Cosmos.DatabaseProperties.Id" />
<MemberSignature Language="VB.NET" Value="Public Property Id As String" />
<MemberSignature Language="F#" Value="member this.Id : string with get, set" Usage="Azure.Cosmos.DatabaseProperties.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Cosmos</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Id of the resource in the Azure Cosmos DB service.
</summary>
<value>The Id associated with the resource.</value>
<remarks>
<para>
Every resource within an Azure Cosmos DB database account needs to have a unique identifier.
</para>
<para>
When working with document resources, they too have this settable Id property.
If an Id is not supplied by the user the SDK will automatically generate a new GUID and assign its value to this property before
persisting the document in the database.
You can override this auto Id generation by setting the disableAutomaticIdGeneration parameter on the <see cref="T:Microsoft.Azure.Cosmos.DocumentClient" /> instance to true.
This will prevent the SDK from generating new Ids.
</para>
<para>
The following characters are restricted and cannot be used in the Id property:
'/', '\\', '?', '#'
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="LastModified">
<MemberSignature Language="C#" Value="public DateTime? LastModified { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> LastModified" />
<MemberSignature Language="DocId" Value="P:Azure.Cosmos.DatabaseProperties.LastModified" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LastModified As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.LastModified : Nullable<DateTime>" Usage="Azure.Cosmos.DatabaseProperties.LastModified" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Cosmos</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the last modified time stamp associated with <see cref="T:Azure.Cosmos.DatabaseProperties" /> from the Azure Cosmos DB service.
</summary>
<value>The last modified time stamp associated with the resource.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>