Skip to content

Commit

Permalink
Grammar check.
Browse files Browse the repository at this point in the history
  • Loading branch information
davidbh committed Aug 27, 2018
1 parent 4fe5596 commit c0fd008
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ The second one is dedicated for dynamic objects:

{CODE find_dynamic_collection_name@ClientApi\Configuration\IdentifierGeneration\Global.cs /}

{INFO:What is a Dynamic Object?}
{INFO: What is a Dynamic Object?}

The `FindCollectionNameForDynamic` only works on objects that inherit from [IDynamicMetaObjectProvider](https://docs.microsoft.com/en-us/dotnet/api/system.dynamic.idynamicmetaobjectprovider) interface. In .NET there are two built-in types that implement that interface, the [ExpandoObject](https://docs.microsoft.com/en-us/dotnet/api/system.dynamic.expandoobject) and [DynamicObject](https://docs.microsoft.com/en-us/dotnet/api/system.dynamic.dynamicobject).

For example if we want to determine a collection using a `Collection` property from a dynamic object we need to set `FindCollectionNameForDynamic` as follows:
For example, if we want to determine a collection using a `Collection` property from a dynamic object, we need to set `FindCollectionNameForDynamic` as follows:

{CODE find_dynamic_collection_name_sample_1@ClientApi\Configuration\IdentifierGeneration\Global.cs /}

Expand All @@ -30,7 +30,7 @@ Collection names determined by recently described convention functions aren't di

{CODE transform_collection_name_to_prefix@ClientApi\Configuration\IdentifierGeneration\Global.cs /}

Its default behavior is that for a collection which contains one upper character it simply converts it to lower case string. `Users` would be transformed into `users`. For collection names containing more upper characters there will be no change. The collection name: `LineItems` would output the following prefix: `LineItems`.
Its default behavior is for a collection which contains one upper character. It simply converts it to lower case string. `Users` would be transformed into `users`. For collection names containing more upper characters, there will be no change. The collection name: `LineItems` would output the following prefix: `LineItems`.

##FindClrTypeName and FindClrType

Expand All @@ -50,7 +50,6 @@ To properly perform the revert conversion that is from a JSON result into a .NET

{CODE find_clr_type@ClientApi\Configuration\IdentifierGeneration\Global.cs /}


##FindIdentityProperty

The client must know where in your entity an identifier is stored to be properly able to transform it into JSON document. It uses the `FindIdentityProperty` convention for that. The default and very common convention is that a property named `Id` is the identifier, so is the default one:
Expand All @@ -61,7 +60,7 @@ You can provide a customization based on the `MemberInfo` parameter to indicate

##FindIdentityPropertyNameFromCollectionName

It can happen that sometimes the results returned by the server don't have identifiers defined (for example if you run a projection query) however they have `@collection` in metadata.
It can happen that sometimes the results returned by the server don't have identifiers defined (for example if you run a projection query). However, they have `@collection` in metadata.

To perform the conversion into a .NET object, a function that finds the identity property name for a given entity name is applied:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ order by score()

## Chaining Orderings

It is also possible to chain multiple orderings of the query results,
i.e. sort the query results first by some specified index field (or by the `@index-score`), then sort all the equal entries by some different index field (or the `@index-score`), etc..
It is also possible to chain multiple orderings of the query results.
You can sort the query results first by some specified index field (or by the `@index-score`), then sort all the equal entries by some different index field (or the `@index-score`).
This can be achived by using the `ThenBy` (`ThenByDescending`) and `ThenByScore` (`ThenByScoreDescending`) methods.

{CODE-TABS}
Expand Down Expand Up @@ -92,7 +92,7 @@ order by random()

## Ordering When a Field is Searchable

When sorting must be done on field that is [Searchable](../../indexes/using-analyzers), due to [Lucene](https://lucene.apache.org/) limitations sorting on such a field is not supported. To overcome this, create another field that is not searchable, and sort by it.
When sorting must be done on field that is [Searchable](../../indexes/using-analyzers), due to [Lucene](https://lucene.apache.org/) limitations sorting on such a field is not supported. To overcome this, create another field that is not searchable and sort by it.

{CODE-TABS}
{CODE-TAB:csharp:Query sorting_6_1@Indexes\Querying\Sorting.cs /}
Expand All @@ -113,7 +113,7 @@ For example, "Abc9" will come after "Abc10" because if treated as single charact

If you want digit characters in a string to be treated as numbers and not as text, you should use alphanumeric ordering. In that case, when comparing "Abc10" to "Abc9", the digits 1 and 0 will be treated as the number 10 which will be considered greater than 9.

To order in this mode, you can pass the `OrderingType.AlphaNumeric` type into `OrderBy` or `OrderByDescending`:
To order in this mode you can pass the `OrderingType.AlphaNumeric` type into `OrderBy` or `OrderByDescending`:

{CODE-TABS}
{CODE-TAB:csharp:Query sorting_7_1@Indexes\Querying\Sorting.cs /}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ When a Windows password is **changed** the following actions are taken:

Changing a password this way is supported and RavenDB is not affected.

On the other hand, if the password was **reset** (either by you or by the administrator) secrets **cannot be decrypted anymore**.
On the other hand, if the password was **reset** (either by you or by the administrator), secrets **cannot be decrypted anymore**.
Please see the [Microsoft Support article](https://support.microsoft.com/en-us/help/309408/how-to-troubleshoot-the-data-protection-api-dpapi#7) to understand the issue.

If you still need to reset the password for some reason, please follow these steps to ensure that secret keys which are protected with DPAPI aren't lost.
Expand All @@ -71,9 +71,9 @@ Run the following get-key command for **every** encrypted database (including `S

The output is the plaintext key which is not protected and not tied to a user.

Now, reset the Windows password.
Now reset the Windows password.

Then run the following put-key command for **every** encrypted database. Supply the path of the database folder and the key you just got (using get-key):
Then, run the following put-key command for **every** encrypted database. Supply the path of the database folder and the key you just got (using get-key):

{CODE-BLOCK:bash}
./rvn offline-operation put-key <path-to-database-dir> <base64-plaintext-key>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The path of the (256-bit) Master Key. If specified, RavenDB will use this key to

{PANEL:Security.MasterKey.Exec}

A command or executable to run which will provide a (256-bit) Master Key, If specified, RavenDB will use this key to protect secrets.
A command or executable to run which will provide a (256-bit) Master Key. If specified, RavenDB will use this key to protect secrets.

- **Type**: `string`
- **Default**: `null`
Expand Down Expand Up @@ -159,9 +159,9 @@ How far back we should retain audit log entries.

{PANEL:Security.WellKnownCertificates.Admin}

Allow to specify well known certificate thumbprints that will be trusted by the server as cluster admins.
Allows you to specify well known certificate thumbprints that will be trusted by the server as cluster admins.

- **Type**: `strings seperated by ;`
- **Type**: `strings separated by ;`
- **Example**: `297430d6d2ce259772e4eccf97863a4dfe6b048c;e6a3b45b062d509b3382282d196efe97d5956ccb`
- **Default**: `null`
- **Scope**: Server-wide only
Expand Down

0 comments on commit c0fd008

Please sign in to comment.