Skip to content

Added C# example to create complex index #24589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Added C# example to create complex index #24589

wants to merge 1 commit into from

Conversation

macel94
Copy link

@macel94 macel94 commented Oct 8, 2021

#24014

All SDK Contribution checklist:

This checklist is used to make sure that common guidelines for a pull request are followed.

  • Please open PR in Draft mode if it is:
    • Work in progress or not intended to be merged.
    • Encountering multiple pipeline failures and working on fixes.
  • If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
  • I have read the contribution guidelines.
  • The pull request does not introduce breaking changes.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

SDK Generation Guidelines

  • The generate.cmd file for the SDK has been updated with the version of AutoRest, as well as the commitid of your swagger spec or link to the swagger spec, used to generate the code. (Track 2 only)
  • The *.csproj and AssemblyInfo.cs files have been updated with the new version of the SDK. Please double check nuget.org current release version.

Additional management plane SDK specific contribution checklist:

Note: Only applies to Microsoft.Azure.Management.[RP] or Azure.ResourceManager.[RP]

  • Include updated management metadata.
  • Update AzureRP.props to add/remove version info to maintain up to date API versions.

Management plane SDK Troubleshooting

  • If this is very first SDK for a services and you are adding new service folders directly under /SDK, please add new service label and/or contact assigned reviewer.

  • If the check fails at the Verify Code Generation step, please ensure:

    • Do not modify any code in generated folders.
    • Do not selectively include/remove generated files in the PR.
    • Do use generate.ps1/cmd to generate this PR instead of calling autorest directly.
      Please pay attention to the @microsoft.csharp version output after running generate.ps1. If it is lower than current released version (2.3.82), please run it again as it should pull down the latest version.

    Note: We have recently updated the PSH module called by generate.ps1 to emit additional data. This would help reduce/eliminate the Code Verification check error. Please run following command:

      `dotnet msbuild eng/mgmt.proj /t:Util /p:UtilityName=InstallPsModules`
    

Old outstanding PR cleanup

Please note:
If PRs (including draft) has been out for more than 60 days and there are no responses from our query or followups, they will be closed to maintain a concise list for our reviewers.

@ghost
Copy link

ghost commented Oct 8, 2021

CLA assistant check
All CLA requirements met.

@@ -359,6 +359,82 @@ SearchIndex index = new SearchIndex("hotels")
client.CreateIndex(index);
```

Or using c# classes with decorators:
```C# Snippet:Azure_Search_Tests_Samples_Readme_CreateManualIndex_CSharp_API
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These snippets are actually declared in-source, for example, search for "Snippet:Azure_Search_Tests_Samples_Readme_CreateManualIndex" like the snippet directly above. We do this to ensure that samples compile and most often run them during testing to make sure they work (and continue to work) correctly.

We also try to keep the most common scenarios in the README to avoid it getting too large. It might be better to instead add a sample under Azure.Search.Documents/test/samples, along with corresponding markdown files in Azure.Search.Documents/samples.

I can help you with that, if you like.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively, instead of a new sample, we could also update one of the existing Hotel samples to add a complex field. This would have the additional benefit that it's already incorporated into existing samples instead of being an entirely separate one.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me it's ok either approach, but i really think to have a list of objects it's not that uncommon.
This is just the first time i used Azure Search and almost immediately i needed a list of objects, that's why I think there is a lack of documentation and tried to add it here.

If you prefer me to modify one of the samples it's ok, could you please point me to the most appropriate one 😄?

Thank you!!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@heaths Over 10% of indexes used in the past 7 days have complex fields, so it's not uncommon.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could include it in an existing sample, then, but 1) sample snippets in markdowns should not be code-complete samples, and 2) need to use the same syntax to make sure they are testable. I think modifying the Hotels sample would be ideal, and make sure the existing snippets show an example of complex types. I don't think it warrants a completely separate sample.

@Mohit-Chakraborty @tg-msft ?

@heaths
Copy link
Member

heaths commented Oct 11, 2021

Our executable samples have a few moving parts, so I prepared #24654 if you want to take a look and see if that helps explain it better.

@heaths
Copy link
Member

heaths commented Oct 18, 2021

Thank you for the PR. Unfortunately, we do require that code shown in snippets gets extracted from buildable and even executed samples or tests, so more was needed as seen in PR #24654. Hopefully this resolves any confusion; however, if not, feel free to reopen this issue with clarification or submit another PR similar to #24654 e.g., that snippet code is added or updated in samples or tests and you run eng/scripts/Update-Snippets.ps1 search after.

@heaths heaths closed this Oct 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants