Updated README.md for Storage DataLake #8604
Conversation
amnguye
requested review from
JoshLove-msft,
seanmcc-msft and
tg-msft
as code owners
|
/azp run net - storage - ci |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
|
||
| ## Examples | ||
|
|
||
| TODO: Add Examples | ||
| ### Create a DataLakeServiceClient | ||
| ```C# Snippet:SampleSnippetDataLakeServiceClient_Create |
There was a problem hiding this comment.
Do you have corresponding #regions? I don't see them in the PR and it's breaking the CI builds.
There was a problem hiding this comment.
What do you mean by regions?
There was a problem hiding this comment.
You need a #region in your C# samples named Snippet:SampleSnippetDataLakeServiceClient_Create and the code will get pulled in when you run C:\src\azure-sdk-for-net\eng\Update-Snippets.ps1.
See #7928 for an overview and the README/Samples for Queues. It's helping us ensure our README code snippets are always up to date and compiling.
amnguye
force-pushed
the
storage/datalake/readme
branch
from
a112c86 to
45eb46c
Compare
| @@ -7,7 +7,7 @@ and analysts to store data of any size, shape, and speed, and do all types of pr | |||
| across platforms and languages. It removes the complexities of ingesting and storing all of your data | |||
| while making it faster to get up and running with batch, streaming, and interactive analytics. | |||
|
|
|||
| [Source code][source] | [API reference documentation][docs] | [REST API documentation][rest_docs] | [Product documentation][product_docs] | |||
| [Source code][source] | [{Package (NuGet)][package] | [API reference documentation][docs] | [REST API documentation][rest_docs] | [Product documentation][product_docs] | |||
|
|
||
| HNS enabled accounts in ADLS Gen2 can also now leverage most of the operations available in Blob SDK. Support for File level semantics for ADLS Gen2 is planned to be made available in Blob SDK in a later release. In the meantime, please find below mapping for ADLS Gen2 terminology to Blob terminology. | ||
| Key Features of DataLake Storage Gen2 include: |
| Data Lake Storage Gen2 offers two types of resources: | ||
|
|
||
| - The _filesystem used via 'DataLakeFileSystemClient' | ||
| - The _path used via 'DataLakeFileClient' or 'DataLakeDirectoryClient' |
There was a problem hiding this comment.
Nit - do you want _s after filesystem and path to close the italics?
| ## Troubleshooting | ||
|
|
||
| All File DataLake service operations will throw a | ||
| [RequestFailedException][RequestFailedException] on failure with | ||
| helpful [`ErrorCode`s][error_codes]. Many of these errors are recoverable. | ||
| helpful [`ErrorCodes`][error_codes]. Many of these errors are recoverable. |
There was a problem hiding this comment.
Nit - the property is called ErrorCode.
| filesystem.Create(); | ||
|
|
||
| // Create a DataLake file using a DataLake Filesystem | ||
| DataLakeFileClient file = filesystem.GetFileClient(Randomize("sample-file")); |
There was a problem hiding this comment.
Nit - you can remove the Randomize on everything but the FileSystems because randomizing the top level thing will still give us unique entries for directories and files. Doesn't have to happen for this PR though.
There was a problem hiding this comment.
Sounds good. Made an issue for this #8631
| filesystem.Create(); | ||
| #endregion Snippet:SampleSnippetDataLakeFileSystemClient_Create | ||
| #region Snippet:SampleSnippetDataLakeFileClient_Create_Directory | ||
| //Create a DataLake Directory |
amnguye
force-pushed
the
storage/datalake/readme
branch
from
73d93ae to
c50bfc7
Compare
Resolves #8589