update samples & rename datasource methods (Azure#11683)

* update samples

* rename datasource methods

Author: xiangyan99

sdk/search/azure-search-documents/CHANGELOG.md

@@ -9,6 +9,7 @@
 - Renamed `edm` to `SearchFieldDataType`    #11511
 - Now Search Synonym Map creation/update returns a model    #11514
 - Renaming  #11565
+
   SearchIndexerDataSource -> SearchIndexerDataSourceConnection
   SearchField.SynonymMaps -> SearchField.SynonymMapNames
   SearchField.Analyzer -> SearchField.AnalyzerName
@@ -21,7 +22,7 @@
   Similarity -> SimilarityAlgorithm
   Suggester -> SearchSuggester
   PathHierarchyTokenizerV2 -> PathHierarchyTokenizer
-    
+- Renamed DataSource methods to DataSourceConnection    #11693
 
 
 ## 1.0.0b3 (2020-05-04)

sdk/search/azure-search-documents/azure/search/documents/indexes/_internal/_search_indexer_client.py

@@ -255,50 +255,50 @@ def get_indexer_status(self, name, **kwargs):
         return self._client.indexers.get_status(name, **kwargs)
 
     @distributed_trace
-    def create_datasource(self, data_source, **kwargs):
+    def create_data_source_connection(self, data_source_connection, **kwargs):
         # type: (SearchIndexerDataSourceConnection, **Any) -> SearchIndexerDataSourceConnection
-        """Creates a new datasource.
+        """Creates a new data source connection.
 
-        :param data_source: The definition of the datasource to create.
-        :type data_source: ~search.models.SearchIndexerDataSourceConnection
+        :param data_source_connection: The definition of the data source connection to create.
+        :type data_source_connection: ~search.models.SearchIndexerDataSourceConnection
         :return: The created SearchIndexerDataSourceConnection
         :rtype: ~search.models.SearchIndexerDataSourceConnection
 
         .. admonition:: Example:
 
             .. literalinclude:: ../samples/sample_data_source_operations.py
-                :start-after: [START create_data_source]
-                :end-before: [END create_data_source]
+                :start-after: [START create_data_source_connection]
+                :end-before: [END create_data_source_connection]
                 :language: python
                 :dedent: 4
                 :caption: Create a Data Source
         """
         kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
-        packed_data_source = pack_search_indexer_data_source(data_source)
+        packed_data_source = pack_search_indexer_data_source(data_source_connection)
         result = self._client.data_sources.create(packed_data_source, **kwargs)
         return unpack_search_indexer_data_source(result)
 
     @distributed_trace
-    def create_or_update_datasource(self, data_source, name=None, **kwargs):
+    def create_or_update_data_source_connection(self, data_source_connection, name=None, **kwargs):
         # type: (SearchIndexerDataSourceConnection, Optional[str], **Any) -> SearchIndexerDataSourceConnection
-        """Creates a new datasource or updates a datasource if it already exists.
-        :param name: The name of the datasource to create or update.
+        """Creates a new data source connection or updates a data source connection if it already exists.
+        :param name: The name of the data source connection to create or update.
         :type name: str
-        :param data_source: The definition of the datasource to create or update.
-        :type data_source: ~search.models.SearchIndexerDataSourceConnection
+        :param data_source_connection: The definition of the data source connection to create or update.
+        :type data_source_connection: ~search.models.SearchIndexerDataSourceConnection
         :keyword match_condition: The match condition to use upon the etag
         :type match_condition: ~azure.core.MatchConditions
         :return: The created SearchIndexerDataSourceConnection
         :rtype: ~search.models.SearchIndexerDataSourceConnection
         """
         kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
         error_map, access_condition = get_access_conditions(
-            data_source, kwargs.pop("match_condition", MatchConditions.Unconditionally)
+            data_source_connection, kwargs.pop("match_condition", MatchConditions.Unconditionally)
         )
         kwargs.update(access_condition)
         if not name:
-            name = data_source.name
-        packed_data_source = pack_search_indexer_data_source(data_source)
+            name = data_source_connection.name
+        packed_data_source = pack_search_indexer_data_source(data_source_connection)
         result = self._client.data_sources.create_or_update(
             data_source_name=name,
             data_source=packed_data_source,
@@ -308,20 +308,20 @@ def create_or_update_datasource(self, data_source, name=None, **kwargs):
         return unpack_search_indexer_data_source(result)
 
     @distributed_trace
-    def get_datasource(self, name, **kwargs):
+    def get_data_source_connection(self, name, **kwargs):
         # type: (str, **Any) -> SearchIndexerDataSourceConnection
-        """Retrieves a datasource definition.
+        """Retrieves a data source connection definition.
 
-        :param name: The name of the datasource to retrieve.
+        :param name: The name of the data source connection to retrieve.
         :type name: str
         :return: The SearchIndexerDataSourceConnection that is fetched.
         :rtype: ~search.models.SearchIndexerDataSourceConnection
 
         .. admonition:: Example:
 
             .. literalinclude:: ../samples/sample_data_source_operations.py
-                :start-after: [START get_data_source]
-                :end-before: [END get_data_source]
+                :start-after: [START get_data_source_connection]
+                :end-before: [END get_data_source_connection]
                 :language: python
                 :dedent: 4
                 :caption: Retrieve a SearchIndexerDataSourceConnection
@@ -331,18 +331,18 @@ def get_datasource(self, name, **kwargs):
         return unpack_search_indexer_data_source(result)
 
     @distributed_trace
-    def get_datasources(self, **kwargs):
+    def get_data_source_connections(self, **kwargs):
         # type: (**Any) -> Sequence[SearchIndexerDataSourceConnection]
-        """Lists all datasources available for a search service.
+        """Lists all data source connections available for a search service.
 
-        :return: List of all the data sources.
+        :return: List of all the data source connections.
         :rtype: `list[~search.models.SearchIndexerDataSourceConnection]`
 
         .. admonition:: Example:
 
             .. literalinclude:: ../samples/sample_data_source_operations.py
-                :start-after: [START list_data_source]
-                :end-before: [END list_data_source]
+                :start-after: [START list_data_source_connection]
+                :end-before: [END list_data_source_connection]
                 :language: python
                 :dedent: 4
                 :caption: List all the SearchIndexerDataSourceConnections
@@ -352,14 +352,14 @@ def get_datasources(self, **kwargs):
         return [unpack_search_indexer_data_source(x) for x in result.data_sources]
 
     @distributed_trace
-    def delete_datasource(self, data_source, **kwargs):
+    def delete_data_source_connection(self, data_source_connection, **kwargs):
         # type: (Union[str, SearchIndexerDataSourceConnection], **Any) -> None
-        """Deletes a datasource. To use access conditions, the Datasource model must be
-        provided instead of the name. It is enough to provide the name of the datasource
+        """Deletes a data source connection. To use access conditions, the SearchIndexerDataSourceConnection
+        model must be provided instead of the name. It is enough to provide the name of the data source connection
         to delete unconditionally
 
-        :param data_source: The datasource to delete.
-        :type data_source: str or ~search.models.SearchIndexerDataSourceConnection
+        :param data_source_connection: The data source connection to delete.
+        :type data_source_connection: str or ~search.models.SearchIndexerDataSourceConnection
         :keyword match_condition: The match condition to use upon the etag
         :type match_condition: ~azure.core.MatchConditions
         :return: None
@@ -368,21 +368,21 @@ def delete_datasource(self, data_source, **kwargs):
         .. admonition:: Example:
 
             .. literalinclude:: ../samples/sample_data_source_operations.py
-                :start-after: [START delete_data_source]
-                :end-before: [END delete_data_source]
+                :start-after: [START delete_data_source_connection]
+                :end-before: [END delete_data_source_connection]
                 :language: python
                 :dedent: 4
                 :caption: Delete a SearchIndexerDataSourceConnection
         """
         kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
         error_map, access_condition = get_access_conditions(
-            data_source, kwargs.pop("match_condition", MatchConditions.Unconditionally)
+            data_source_connection, kwargs.pop("match_condition", MatchConditions.Unconditionally)
         )
         kwargs.update(access_condition)
         try:
-            name = data_source.name
+            name = data_source_connection.name
         except AttributeError:
-            name = data_source
+            name = data_source_connection
         self._client.data_sources.delete(
             data_source_name=name, error_map=error_map, **kwargs
         )

sdk/search/azure-search-documents/azure/search/documents/indexes/_internal/aio/_search_indexer_client.py

@@ -255,49 +255,49 @@ async def get_indexer_status(self, name, **kwargs):
         return await self._client.indexers.get_status(name, **kwargs)
 
     @distributed_trace_async
-    async def create_datasource(self, data_source, **kwargs):
+    async def create_data_source_connection(self, data_source_connection, **kwargs):
         # type: (SearchIndexerDataSourceConnection, **Any) -> SearchIndexerDataSourceConnection
-        """Creates a new datasource.
-        :param data_source: The definition of the datasource to create.
-        :type data_source: ~search.models.SearchIndexerDataSourceConnection
+        """Creates a new data source connection.
+        :param data_source_connection: The definition of the data source connection to create.
+        :type data_source_connection: ~search.models.SearchIndexerDataSourceConnection
         :return: The created SearchIndexerDataSourceConnection
         :rtype: ~search.models.SearchIndexerDataSourceConnection
 
         .. admonition:: Example:
 
             .. literalinclude:: ../samples/async_samples/sample_data_source_operations_async.py
-                :start-after: [START create_data_source_async]
-                :end-before: [END create_data_source_async]
+                :start-after: [START create_data_source_connection_async]
+                :end-before: [END create_data_source_connection_async]
                 :language: python
                 :dedent: 4
                 :caption: Create a SearchIndexerDataSourceConnection
         """
         kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
-        packed_data_source = pack_search_indexer_data_source(data_source)
+        packed_data_source = pack_search_indexer_data_source(data_source_connection)
         result = await self._client.data_sources.create(packed_data_source, **kwargs)
         return unpack_search_indexer_data_source(result)
 
     @distributed_trace_async
-    async def create_or_update_datasource(self, data_source, name=None, **kwargs):
+    async def create_or_update_data_source_connection(self, data_source_connection, name=None, **kwargs):
         # type: (SearchIndexerDataSourceConnection, Optional[str], **Any) -> SearchIndexerDataSourceConnection
-        """Creates a new datasource or updates a datasource if it already exists.
-        :param name: The name of the datasource to create or update.
+        """Creates a new data source connection or updates a data source connection if it already exists.
+        :param name: The name of the data source connection to create or update.
         :type name: str
-        :param data_source: The definition of the datasource to create or update.
-        :type data_source: ~search.models.SearchIndexerDataSourceConnection
+        :param data_source_connection: The definition of the data source connection to create or update.
+        :type data_source_connection: ~search.models.SearchIndexerDataSourceConnection
         :keyword match_condition: The match condition to use upon the etag
         :type match_condition: ~azure.core.MatchConditions
         :return: The created SearchIndexerDataSourceConnection
         :rtype: ~search.models.SearchIndexerDataSourceConnection
         """
         kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
         error_map, access_condition = get_access_conditions(
-            data_source, kwargs.pop("match_condition", MatchConditions.Unconditionally)
+            data_source_connection, kwargs.pop("match_condition", MatchConditions.Unconditionally)
         )
         kwargs.update(access_condition)
         if not name:
-            name = data_source.name
-        packed_data_source = pack_search_indexer_data_source(data_source)
+            name = data_source_connection.name
+        packed_data_source = pack_search_indexer_data_source(data_source_connection)
         result = await self._client.data_sources.create_or_update(
             data_source_name=name,
             data_source=packed_data_source,
@@ -307,14 +307,14 @@ async def create_or_update_datasource(self, data_source, name=None, **kwargs):
         return unpack_search_indexer_data_source(result)
 
     @distributed_trace_async
-    async def delete_datasource(self, data_source, **kwargs):
+    async def delete_data_source_connection(self, data_source_connection, **kwargs):
         # type: (Union[str, SearchIndexerDataSourceConnection], **Any) -> None
-        """Deletes a datasource. To use access conditions, the Datasource model must be
-        provided instead of the name. It is enough to provide the name of the datasource
-        to delete unconditionally
+        """Deletes a data source connection. To use access conditions, the
+        SearchIndexerDataSourceConnection model must be provided instead of the name.
+        It is enough to provide the name of the data source connection to delete unconditionally
 
-        :param data_source: The datasource to delete.
-        :type data_source: str or ~search.models.SearchIndexerDataSourceConnection
+        :param data_source_connection: The data source connection to delete.
+        :type data_source_connection: str or ~search.models.SearchIndexerDataSourceConnection
         :keyword match_condition: The match condition to use upon the etag
         :type match_condition: ~azure.core.MatchConditions
         :return: None
@@ -331,30 +331,30 @@ async def delete_datasource(self, data_source, **kwargs):
         """
         kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
         error_map, access_condition = get_access_conditions(
-            data_source, kwargs.pop("match_condition", MatchConditions.Unconditionally)
+            data_source_connection, kwargs.pop("match_condition", MatchConditions.Unconditionally)
         )
         kwargs.update(access_condition)
         try:
-            name = data_source.name
+            name = data_source_connection.name
         except AttributeError:
-            name = data_source
+            name = data_source_connection
         await self._client.data_sources.delete(
             data_source_name=name, error_map=error_map, **kwargs
         )
 
     @distributed_trace_async
-    async def get_datasource(self, name, **kwargs):
+    async def get_data_source_connection(self, name, **kwargs):
         # type: (str, **Any) -> SearchIndexerDataSourceConnection
-        """Retrieves a datasource definition.
+        """Retrieves a data source connection definition.
 
-        :param name: The name of the datasource to retrieve.
+        :param name: The name of the data source connection to retrieve.
         :type name: str
         :return: The SearchIndexerDataSourceConnection that is fetched.
         :rtype: ~search.models.SearchIndexerDataSourceConnection
 
             .. literalinclude:: ../samples/async_samples/sample_data_source_operations_async.py
-                :start-after: [START get_data_source_async]
-                :end-before: [END get_data_source_async]
+                :start-after: [START get_data_source_connection_async]
+                :end-before: [END get_data_source_connection_async]
                 :language: python
                 :dedent: 4
                 :caption: Retrieve a SearchIndexerDataSourceConnection
@@ -364,18 +364,18 @@ async def get_datasource(self, name, **kwargs):
         return unpack_search_indexer_data_source(result)
 
     @distributed_trace_async
-    async def get_datasources(self, **kwargs):
+    async def get_data_source_connections(self, **kwargs):
         # type: (**Any) -> Sequence[SearchIndexerDataSourceConnection]
-        """Lists all datasources available for a search service.
+        """Lists all data source connections available for a search service.
 
-        :return: List of all the data sources.
+        :return: List of all the data source connections.
         :rtype: `list[~search.models.SearchIndexerDataSourceConnection]`
 
         .. admonition:: Example:
 
             .. literalinclude:: ../samples/async_samples/sample_data_source_operations_async.py
-                :start-after: [START list_data_source_async]
-                :end-before: [END list_data_source_async]
+                :start-after: [START list_data_source_connection_async]
+                :end-before: [END list_data_source_connection_async]
                 :language: python
                 :dedent: 4
                 :caption: List all SearchIndexerDataSourceConnections

sdk/search/azure-search-documents/samples/async_samples/sample_analyze_text_async.py

@@ -29,15 +29,14 @@
 async def simple_analyze_text():
     # [START simple_analyze_text_async]
     from azure.core.credentials import AzureKeyCredential
-    from azure.search.documents.aio import SearchServiceClient
-    from azure.search.documents import AnalyzeRequest
+    from azure.search.documents.indexes.aio import SearchIndexClient
+    from azure.search.documents.indexes.models import AnalyzeRequest
 
-    service_client = SearchServiceClient(service_endpoint, AzureKeyCredential(key))
-    client = service_client.get_indexes_client()
+    client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
 
     analyze_request = AnalyzeRequest(text="One's <two/>", analyzer="standard.lucene")
 
-    async with service_client:
+    async with client:
         result = await client.analyze_text(index_name, analyze_request)
         print(result.as_dict())
     # [END simple_analyze_text_async]

sdk/search/azure-search-documents/samples/async_samples/sample_authentication_async.py

@@ -42,11 +42,11 @@ async def authentication_with_api_key_credential_async():
 async def authentication_service_client_with_api_key_credential_async():
     # [START create_search_service_with_key_async]
     from azure.core.credentials import AzureKeyCredential
-    from azure.search.documents.aio import SearchServiceClient
+    from azure.search.documents.indexes.aio import SearchIndexClient
     service_endpoint = os.getenv("AZURE_SEARCH_SERVICE_ENDPOINT")
     key = os.getenv("AZURE_SEARCH_API_KEY")
 
-    client = SearchServiceClient(service_endpoint, AzureKeyCredential(key))
+    client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
     # [END create_search_service_with_key_async]
 
 if __name__ == '__main__':

sdk/search/azure-search-documents/samples/async_samples/sample_autocomplete_async.py

@@ -32,7 +32,7 @@ async def autocomplete_query():
     # [START autocomplete_query_async]
     from azure.core.credentials import AzureKeyCredential
     from azure.search.documents.aio import SearchClient
-    from azure.search.documents import AutocompleteQuery
+    from azure.search.documents.models import AutocompleteQuery
 
     search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))
 

sdk/search/azure-search-documents/samples/async_samples/sample_crud_operations_async.py

@@ -29,7 +29,7 @@
 
 from azure.core.credentials import AzureKeyCredential
 from azure.search.documents.aio import SearchClient
-from azure.search.documents import SearchQuery
+from azure.search.documents.models import SearchQuery
 
 search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))