ServiceX Reference Guide¶
This reference documentation covers the details of ServiceX needed to build complex analysis workflows. It is one part of a broader suite of documentation available in the navigation bar above.
For users who are not yet familiar with ServiceX, the following resources provide a starting point:
15 Minute Histogram Challenge
The 15 Minute Histogram Challenge provides a quick introduction to ServiceX for users evaluating whether it fits their analysis needs.
User Guide
The User Guide covers the core concepts and workflows of ServiceX for new users.
Example Workflows
The ServiceX Workflows collection provides end-to-end examples covering common real-world analysis steps.
Queries
Other API
servicexpackageservicex.apppackageservicexclient internals- servicex.expandable_progress module
- servicex.minio_adapter module
- servicex.query module
- servicex.query_cache module
CacheExceptionQueryCacheQueryCache.cache_path_for_transform()QueryCache.cache_submitted_transform()QueryCache.cache_transform()QueryCache.cached_queries()QueryCache.close()QueryCache.contains_hash()QueryCache.delete_record_by_hash()QueryCache.delete_record_by_request_id()QueryCache.get_transform_by_hash()QueryCache.get_transform_by_request_id()QueryCache.get_transform_request_id()QueryCache.is_transform_request_submitted()QueryCache.queries_in_state()QueryCache.transformed_results()QueryCache.update_record()QueryCache.update_transform_request_id()QueryCache.update_transform_status()
- servicex.servicex_adapter module
AuthorizationErrorServiceXAdapterServiceXAdapter.cancel_transform()ServiceXAdapter.delete_dataset()ServiceXAdapter.delete_transform()ServiceXAdapter.get_code_generators()ServiceXAdapter.get_code_generators_async()ServiceXAdapter.get_dataset()ServiceXAdapter.get_datasets()ServiceXAdapter.get_servicex_capabilities()ServiceXAdapter.get_servicex_info()ServiceXAdapter.get_servicex_sample_title_limit()ServiceXAdapter.get_transform_status()ServiceXAdapter.get_transformation_results()ServiceXAdapter.get_transforms()ServiceXAdapter.submit_transform()
ServiceXFile
- servicex.servicex_client module
GuardListProgressBarFormatReturnValueExceptionServiceXClientServiceXClient.cancel_transform()ServiceXClient.delete_dataset()ServiceXClient.delete_transform()ServiceXClient.delete_transform_from_cache()ServiceXClient.generic_query()ServiceXClient.get_code_generators()ServiceXClient.get_dataset()ServiceXClient.get_datasets()ServiceXClient.get_transform_status()ServiceXClient.get_transform_status_async()ServiceXClient.get_transforms()ServiceXClient.get_transforms_async()
deliver()deliver_async()
- servicex.types module
- Configuration
- DataBinder
- Models
CachedDatasetDatasetFileDocStringBaseModelResultDestinationResultFileResultFormatServiceXInfoStatusTransformRequestTransformStatusTransformStatus.request_idTransformStatus.didTransformStatus.did_idTransformStatus.titleTransformStatus.selectionTransformStatus.tree_nameTransformStatus.imageTransformStatus.result_destinationTransformStatus.result_formatTransformStatus.generated_code_cmTransformStatus.statusTransformStatus.app_versionTransformStatus.filesTransformStatus.files_completedTransformStatus.files_failedTransformStatus.files_remainingTransformStatus.submit_timeTransformStatus.finish_timeTransformStatus.minio_endpointTransformStatus.minio_securedTransformStatus.minio_access_keyTransformStatus.minio_secret_keyTransformStatus.log_url
TransformedResultsTransformedResults.hashTransformedResults.titleTransformedResults.codegenTransformedResults.request_idTransformedResults.submit_timeTransformedResults.data_dirTransformedResults.file_listTransformedResults.signed_url_listTransformedResults.filesTransformedResults.result_formatTransformedResults.log_url