code migration from https://github.com/MindFlavor/AzureSDKForRust
This commit is contained in:
Francesco Cogno
Родитель
3fb06c1be9
Коммит
638d0322d1
|
|
@ -0,0 +1,9 @@
|
|||
# Microsoft Open Source Code of Conduct
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
|
||||
Resources:
|
||||
|
||||
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
|
||||
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
|
||||
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
|
||||
214
LICENSE
214
LICENSE
|
|
@ -1,201 +1,21 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
MIT License
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
Copyright (c) Microsoft Corporation.
|
||||
|
||||
1. Definitions.
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2015-2016 Francesco Cogno
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE
|
||||
|
|
|
|||
295
README.md
295
README.md
|
|
@ -1,289 +1,14 @@
|
|||
# Microsoft Azure SDK for Rust
|
||||
|
||||
> :construction: :construction:
|
||||
>
|
||||
> **Warning**: This repo is in *maintenance mode* only.
|
||||
> It's being migrated to the [Microsoft Open Source](https://github.com/Azure) org :two_hearts:. The new repo is here [https://github.com/Azure/azure-sdk-for-rust](https://github.com/Azure/azure-sdk-for-rust).
|
||||
>
|
||||
> In maintenance mode only essential PRs will be accepted; non bug-related issues will be closed.
|
||||
> As soon as the migration is completed this repo will become read-only.
|
||||
>
|
||||
> :construction: :construction:
|
||||
# Contributing
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
||||
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
|
||||
|
||||
[](LICENSE)
|
||||
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
|
||||
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
|
||||
provided by the bot. You will only need to do this once across all repos using our CLA.
|
||||
|
||||
[](https://travis-ci.org/MindFlavor/AzureSDKForRust) [](https://coveralls.io/github/MindFlavor/AzureSDKForRust?branch=master) 
|
||||
|
||||
[](https://github.com/MindFlavor/AzureSDKForRust/tree/queue_0.1.0) [](https://github.com/MindFlavor/AzureSDKForRust/releases/tag/queue_0.1.0) [](https://github.com/MindFlavor/AzureSDKForRust/commits/master)
|
||||
|
||||
[](https://github.com/MindFlavor/AzureSDKForRust/graphs/contributors)
|
||||
|
||||
Crate repo | Docs | Crates.io | Downloads | Downloads@Latest |
|
||||
-- | -- | -- | -- | -- |
|
||||
[azure_sdk_auth_aad](https://github.com/MindFlavor/AzureSDKForRust/tree/master/azure_sdk_auth_aad) | [](https://docs.rs/azure_sdk_auth_aad) | [](https://crates.io/crates/azure_sdk_auth_aad) | [](https://crates.io/crates/azure_sdk_auth_aad) | [](https://crates.io/crates/azure_sdk_auth_aad)
|
||||
[azure_sdk_core](https://github.com/MindFlavor/AzureSDKForRust/tree/master/azure_sdk_core) | [](https://docs.rs/azure_sdk_core) | [](https://crates.io/crates/azure_sdk_core) | [](https://crates.io/crates/azure_sdk_core) | [](https://crates.io/crates/azure_sdk_core)
|
||||
[azure_sdk_cosmos](https://github.com/MindFlavor/AzureSDKForRust/tree/master/azure_sdk_cosmos) | [](https://docs.rs/azure_sdk_cosmos) | [](https://crates.io/crates/azure_sdk_cosmos) | [](https://crates.io/crates/azure_sdk_cosmos) | [](https://crates.io/crates/azure_sdk_cosmos)
|
||||
[azure_sdk_service_bus](https://github.com/MindFlavor/AzureSDKForRust/tree/master/azure_sdk_service_bus) | [](https://docs.rs/azure_sdk_service_bus) | [](https://crates.io/crates/azure_sdk_service_bus) | [](https://crates.io/crates/azure_sdk_service_bus) | [](https://crates.io/crates/azure_sdk_service_bus)
|
||||
[azure_sdk_storage_account](https://github.com/MindFlavor/AzureSDKForRust/tree/master/azure_sdk_storage_account) | [](https://docs.rs/azure_sdk_storage_account) | [](https://crates.io/crates/azure_sdk_storage_account) | [](https://crates.io/crates/azure_sdk_storage_account) | [](https://crates.io/crates/azure_sdk_storage_account)
|
||||
[azure_sdk_storage_blob](https://github.com/MindFlavor/AzureSDKForRust/tree/master/azure_sdk_storage_blob) | [](https://docs.rs/azure_sdk_storage_blob) | [](https://crates.io/crates/azure_sdk_storage_blob) | [](https://crates.io/crates/azure_sdk_storage_blob) | [](https://crates.io/crates/azure_sdk_storage_blob)
|
||||
[azure_sdk_storage_queue](https://github.com/MindFlavor/AzureSDKForRust/tree/master/azure_sdk_storage_queue) | [](https://docs.rs/azure_sdk_storage_queue) | [](https://crates.io/crates/azure_sdk_storage_queue) | [](https://crates.io/crates/azure_sdk_storage_queue) | [](https://crates.io/crates/azure_sdk_storage_queue)
|
||||
[azure_sdk_storage_core](https://github.com/MindFlavor/AzureSDKForRust/tree/master/azure_sdk_storage_core) | [](https://docs.rs/azure_sdk_storage_core) | [](https://crates.io/crates/azure_sdk_storage_core) | [](https://crates.io/crates/azure_sdk_storage_core) | [](https://crates.io/crates/azure_sdk_storage_core)
|
||||
[azure_sdk_storage_table](https://github.com/MindFlavor/AzureSDKForRust/tree/master/azure_sdk_storage_table) | [](https://docs.rs/azure_sdk_storage_table) | [](https://crates.io/crates/azure_sdk_storage_table) | [](https://crates.io/crates/azure_sdk_storage_table) | [](https://crates.io/crates/azure_sdk_storage_table)
|
||||
|
||||
#### Ancillary crates
|
||||
|
||||
Ancillary crates are maintained in a separated GitHub repo by other members of the community. If you have a crate that you want to list here do not hesitate to drop a line/PR.
|
||||
|
||||
Crate repo | Maintainer | Docs | Crates.io | Downloads | Downloads@Latest | Contributors
|
||||
-- | -- | -- | -- | -- | -- | -- |
|
||||
[azure-sdk-keyvault](https://github.com/guywaldman/azure-sdk-keyvault) | [Guy Waldman](https://github.com/guywaldman) | [](https://docs.rs/azure-sdk-keyvault) | [](https://crates.io/crates/azure_sdk_keyvault) | [](https://crates.io/crates/azure_sdk_keyvault) | [](https://crates.io/crates/azure_sdk_keyvault) | [](https://github.com/guywaldman/azure-sdk-keyvault/graphs/contributors)
|
||||
|
||||
## Introduction
|
||||
Microsoft Azure exposes its technologies via REST API. These APIs are easily consumable from any language (good) but are weakly typed. With this library and its related [crate](https://crates.io/crates/azure_sdk_for_rust/) you can exploit the power of Microsoft Azure from Rust in a idiomatic way.
|
||||
|
||||
This crate relies heavily on the excellent crate called [Hyper](https://github.com/hyperium/hyper). As of this library version [0.30.0](https://github.com/MindFlavor/AzureSDKForRust/releases/tag/0.30.0) all the methods are async/await compliant (`futures 0.3`).
|
||||
|
||||
From version 0.8.0 for Cosmos and 0.9.0 for Storage the repo is embracing the builder pattern. As of 0.10.0, most of storage APIs have been migrated to the builder pattern but there are methods still missing. Please chech the relevant issues to follow the update process. This is still an in-progress transition but the resulting API is much more easy to use. Also most checks have been moved to compile-time. Unfortunately the changes are not backward-compatibile. I have blogged about my appoach here: [https://dev.to/mindflavor/rust-builder-pattern-with-types-3chf](https://dev.to/mindflavor/rust-builder-pattern-with-types-3chf).
|
||||
|
||||
From version 0.12.0 the library switched from [hyper-tls](https://github.com/hyperium/hyper-tls) to [hyper-rustls](https://github.com/ctz/hyper-rustls) as suggested by [bmc-msft](https://github.com/bmc-msft) in the issue [#120](https://github.com/MindFlavor/AzureSDKForRust/issues/120). This should allow the library to be 100% rust.
|
||||
|
||||
> **NOTE:** This repository is under heavy development and is likely to break over time. The current releases will probabily contain bugs. As usual open issues if you find any.
|
||||
|
||||
## Disclaimer
|
||||
Although I am a Microsoft employee, this is not a Microsoft endorsed project. It's simply a pet project of mine: I love Rust (who doesn't? :smirk:) and Microsoft Azure technologies so I thought to close the gap between them. It's also a good project for learning Rust. This library relies heavily on [Hyper](https://github.com/hyperium/hyper). We use the latest Hyper code so this library is fully async with Futures and Tokio.
|
||||
|
||||
## Example
|
||||
You can find examples in the [```examples```](https://github.com/MindFlavor/AzureSDKForRust/tree/master/azure_sdk_cosmos/examples) folder of each sub-crate. Here is a glimpse:
|
||||
|
||||
### main.rs
|
||||
|
||||
```rust
|
||||
#[macro_use]
|
||||
extern crate serde_derive;
|
||||
// Using the prelude module of the Cosmos crate makes easier to use the Rust Azure SDK for Cosmos
|
||||
// DB.
|
||||
use azure_sdk_core::prelude::*;
|
||||
use azure_sdk_cosmos::prelude::*;
|
||||
use futures::stream::StreamExt;
|
||||
use std::borrow::Cow;
|
||||
use std::error::Error;
|
||||
|
||||
// This is the stuct we want to use in our sample.
|
||||
// Make sure to have a collection with partition key "a_number" for this example to
|
||||
// work (you can create with this SDK too, check the examples folder for that task).
|
||||
#[derive(Serialize, Deserialize, Debug)]
|
||||
struct MySampleStruct<'a> {
|
||||
id: Cow<'a, str>,
|
||||
a_string: Cow<'a, str>,
|
||||
a_number: u64,
|
||||
a_timestamp: i64,
|
||||
}
|
||||
|
||||
// This code will perform these tasks:
|
||||
// 1. Create 10 documents in the collection.
|
||||
// 2. Stream all the documents.
|
||||
// 3. Query the documents.
|
||||
// 4. Delete the documents returned by task 4.
|
||||
// 5. Check the remaining documents.
|
||||
#[tokio::main]
|
||||
async fn main() -> Result<(), Box<dyn Error>> {
|
||||
// Let's get Cosmos account and master key from env variables.
|
||||
// This helps automated testing.
|
||||
let master_key =
|
||||
std::env::var("COSMOS_MASTER_KEY").expect("Set env variable COSMOS_MASTER_KEY first!");
|
||||
let account = std::env::var("COSMOS_ACCOUNT").expect("Set env variable COSMOS_ACCOUNT first!");
|
||||
|
||||
let database_name = std::env::args()
|
||||
.nth(1)
|
||||
.expect("please specify the database name as first command line parameter");
|
||||
let collection_name = std::env::args()
|
||||
.nth(2)
|
||||
.expect("please specify the collection name as first command line parameter");
|
||||
|
||||
// First, we create an authorization token. There are two types of tokens, master and resource
|
||||
// constrained. This SDK supports both.
|
||||
// Please check the Azure documentation for details or the examples folder
|
||||
// on how to create and use token-based permissions.
|
||||
let authorization_token = AuthorizationToken::new_master(&master_key)?;
|
||||
|
||||
// Next we will create a Cosmos client.
|
||||
let client = ClientBuilder::new(account, authorization_token)?;
|
||||
// We know the database so we can obtain a database client.
|
||||
let database_client = client.with_database_client(database_name);
|
||||
// We know the collection so we can obtain a collection client.
|
||||
let collection_client = database_client.with_collection_client(collection_name);
|
||||
|
||||
// TASK 1 - Insert 10 documents
|
||||
println!("Inserting 10 documents...");
|
||||
let mut session_token = None;
|
||||
for i in 0..10 {
|
||||
// define the document.
|
||||
let document_to_insert = Document::new(MySampleStruct {
|
||||
id: Cow::Owned(format!("unique_id{}", i)),
|
||||
a_string: Cow::Borrowed("Something here"),
|
||||
a_number: i * 100, // this is the partition key
|
||||
a_timestamp: chrono::Utc::now().timestamp(),
|
||||
});
|
||||
|
||||
// insert it and store the returned session token for later use!
|
||||
session_token = Some(
|
||||
collection_client
|
||||
.create_document()
|
||||
.with_partition_keys(
|
||||
PartitionKeys::new().push(&document_to_insert.document.a_number)?,
|
||||
)
|
||||
.with_is_upsert(true) // this option will overwrite a preexisting document (if any)
|
||||
.execute_with_document(&document_to_insert)
|
||||
.await?
|
||||
.session_token, // get only the session token, if everything else was ok!
|
||||
);
|
||||
}
|
||||
// wow that was easy and fast, wasnt'it? :)
|
||||
println!("Done!");
|
||||
|
||||
let session_token = ConsistencyLevel::from(session_token.unwrap());
|
||||
|
||||
// TASK 2
|
||||
{
|
||||
println!("\nStreaming documents");
|
||||
// we limit the number of documents to 3 for each batch as a demonstration. In practice
|
||||
// you will use a more sensible number (or accept the Azure default).
|
||||
let stream = collection_client
|
||||
.list_documents()
|
||||
.with_consistency_level(session_token.clone())
|
||||
.with_max_item_count(3);
|
||||
let mut stream = Box::pin(stream.stream::<MySampleStruct>());
|
||||
// TODO: As soon as the streaming functionality is stabilized
|
||||
// in Rust we can substitute this while let Some... into
|
||||
// for each (or whatever the Rust team picks).
|
||||
while let Some(res) = stream.next().await {
|
||||
let res = res?;
|
||||
println!("Received {} documents in one batch!", res.documents.len());
|
||||
res.documents.iter().for_each(|doc| println!("{:#?}", doc));
|
||||
}
|
||||
}
|
||||
|
||||
// TASK 3
|
||||
println!("\nQuerying documents");
|
||||
let query_documents_response = collection_client
|
||||
.query_documents()
|
||||
.with_query(&("SELECT * FROM A WHERE A.a_number < 600".into())) // there are other ways to construct a query, this is the simplest.
|
||||
.with_query_cross_partition(true) // this will perform a cross partition query! notice how simple it is!
|
||||
.with_consistency_level(session_token)
|
||||
.execute::<MySampleStruct>() // This will make sure the result is our custom struct!
|
||||
.await?
|
||||
.into_documents() // queries can return Documents or Raw json (ie without etag, _rid, etc...). Since our query return docs we convert with this function.
|
||||
.unwrap(); // we know in advance that the conversion to Document will not fail since we SELECT'ed * FROM table
|
||||
|
||||
println!(
|
||||
"Received {} documents!",
|
||||
query_documents_response.results.len()
|
||||
);
|
||||
|
||||
query_documents_response
|
||||
.results
|
||||
.iter()
|
||||
.for_each(|document| {
|
||||
println!("number ==> {}", document.result.a_number);
|
||||
});
|
||||
|
||||
// TASK 4
|
||||
let session_token = ConsistencyLevel::from(query_documents_response.session_token.clone());
|
||||
for ref document in query_documents_response.results {
|
||||
// From our query above we are sure to receive a Document.
|
||||
println!(
|
||||
"deleting id == {}, a_number == {}.",
|
||||
document.result.id, document.result.a_number
|
||||
);
|
||||
|
||||
// to spice the delete a little we use optimistic concurreny
|
||||
collection_client
|
||||
.with_document_client(&document.result.id as &str, document.result.a_number.into())
|
||||
.delete_document()
|
||||
.with_consistency_level(session_token.clone())
|
||||
.with_if_match_condition((&document.document_attributes).into())
|
||||
.execute()
|
||||
.await?;
|
||||
}
|
||||
|
||||
// TASK 5
|
||||
// Now the list documents should return 4 documents!
|
||||
let list_documents_response = collection_client
|
||||
.list_documents()
|
||||
.with_consistency_level(session_token)
|
||||
.execute::<serde_json::Value>() // you can use this if you don't know/care about the return type!
|
||||
.await?;
|
||||
assert_eq!(list_documents_response.documents.len(), 4);
|
||||
|
||||
Ok(())
|
||||
}
|
||||
```
|
||||
|
||||
## State of the art
|
||||
Right now the key framework is in place (authentication, enumerations, parsing and so on). If you want to contribute please do!
|
||||
Methods are added daily so please check the [release page](https://github.com/MindFlavor/AzureSDKForRust/releases) for updates on the progress.
|
||||
Also note that the project is in early stages so the APIs are bound to change at any moment. I will strive to keep things steady but since I'm new to Rust I'm sure I'll have to correct some serious mistake before too long :smile:.
|
||||
I generally build for the latest nightly and leave to Travis to check the retrocompatibility.
|
||||
|
||||
## Contributing
|
||||
If you want to contribute please do! No formality required! :wink:. Please note that asking for a pull request you accept to yield your code as per [Apache license, version 2.0](LICENSE).
|
||||
|
||||
## Run E2E test
|
||||
|
||||
### Linux
|
||||
|
||||
```bash
|
||||
export STORAGE_ACCOUNT=<account>
|
||||
export STORAGE_MASTER_KEY=<key>
|
||||
|
||||
export AZURE_SERVICE_BUS_NAMESPACE=<azure_service_bus_namespace>
|
||||
export AZURE_EVENT_HUB_NAME=<azure_event_hub_name>
|
||||
export AZURE_POLICY_NAME=<azure_policy_name>
|
||||
export AZURE_POLICY_KEY=<azure policy key>
|
||||
|
||||
export COSMOS_ACCOUNT=<cosmos_account>
|
||||
export COSMOS_KEY=<cosmos_master_key>
|
||||
|
||||
cd azure_sdk_service_bus
|
||||
cargo test --features=test_e2e
|
||||
|
||||
cd ../azure_sdk_storage_blob
|
||||
cargo test --features=test_e2e
|
||||
|
||||
cd ../azure_sdk_storage_account
|
||||
cargo test --features=test_e2e
|
||||
|
||||
cd ../azure_sdk_cosmos
|
||||
cargo test --features=test_e2e
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
```bat
|
||||
set STORAGE_ACCOUNT=<account>
|
||||
set STORAGE_MASTER_KEY=<key>
|
||||
|
||||
set AZURE_SERVICE_BUS_NAMESPACE=<azure_service_bus_namespace>
|
||||
set AZURE_EVENT_HUB_NAME=<azure_event_hub_name>
|
||||
set AZURE_POLICY_NAME=<azure_policy_name>
|
||||
set AZURE_POLICY_KEY=<azure policy key>
|
||||
|
||||
set COSMOS_ACCOUNT=<cosmos_account>
|
||||
set COSMOS_MASTER_KEY=<cosmos_master_key>
|
||||
|
||||
cd azure_sdk_service_bus
|
||||
cargo test --features=test_e2e
|
||||
|
||||
cd ../azure_sdk_storage_blob
|
||||
cargo test --features=test_e2e
|
||||
|
||||
cd ../azure_sdk_storage_account
|
||||
cargo test --features=test_e2e
|
||||
|
||||
cd ../azure_sdk_cosmos
|
||||
cargo test --features=test_e2e
|
||||
```
|
||||
|
||||
## License
|
||||
This project is published under [Apache license, version 2.0](LICENSE).
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,41 @@
|
|||
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.5 BLOCK -->
|
||||
|
||||
## Security
|
||||
|
||||
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
|
||||
|
||||
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
|
||||
|
||||
## Reporting Security Issues
|
||||
|
||||
**Please do not report security vulnerabilities through public GitHub issues.**
|
||||
|
||||
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
|
||||
|
||||
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
|
||||
|
||||
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
|
||||
|
||||
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
|
||||
|
||||
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
|
||||
* Full paths of source file(s) related to the manifestation of the issue
|
||||
* The location of the affected source code (tag/branch/commit or direct URL)
|
||||
* Any special configuration required to reproduce the issue
|
||||
* Step-by-step instructions to reproduce the issue
|
||||
* Proof-of-concept or exploit code (if possible)
|
||||
* Impact of the issue, including how an attacker might exploit the issue
|
||||
|
||||
This information will help us triage your report more quickly.
|
||||
|
||||
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
|
||||
|
||||
## Preferred Languages
|
||||
|
||||
We prefer all communications to be in English.
|
||||
|
||||
## Policy
|
||||
|
||||
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
|
||||
|
||||
<!-- END MICROSOFT SECURITY.MD BLOCK -->
|
||||
Загрузка…
Ссылка в новой задаче