diff --git a/docs/content/en/docs/execution/exports/_index.md b/docs/content/en/docs/execution/exports/_index.md index c5d226e59..d8b1701a6 100644 --- a/docs/content/en/docs/execution/exports/_index.md +++ b/docs/content/en/docs/execution/exports/_index.md @@ -63,8 +63,6 @@ def export_tabular(): workspace_id = "demo", insight_id = "revenue", file_format = "CSV", - # The flag use_labels ensures that names of columns are according to your model - use_labels = True, file_name = "revenue_export.csv" ) diff --git a/docs/content/en/docs/execution/exports/export_pdf.md b/docs/content/en/docs/execution/exports/export_pdf.md index 5c286fe89..830fb3813 100644 --- a/docs/content/en/docs/execution/exports/export_pdf.md +++ b/docs/content/en/docs/execution/exports/export_pdf.md @@ -25,10 +25,10 @@ The ID of the GoodData Workspace. The ID of the GoodData Dashboard. {{< /parameter >}} {{< parameter p_name="file_name" p_type="String" >}} -The name of the PDF file (excluding the file extension). Defaults to Path.cwd() +The name of the PDF file (excluding the file extension). {{< /parameter >}} {{< parameter p_name="store_path" p_type="Union[String, Path]" >}} -The name of the PDF file (excluding the file extension). Defaults to Path.cwd() +The name of the PDF file (excluding the file extension). {{< /parameter >}} {{< parameter p_name="timeout" p_type="float" >}} The maximum amount of time (in seconds) to wait for the server to process the export. Defaults to 60.0. diff --git a/docs/content/en/docs/execution/exports/export_tabular_by_insight_id.md b/docs/content/en/docs/execution/exports/export_tabular_by_insight_id.md index 9971f342b..26929fcef 100644 --- a/docs/content/en/docs/execution/exports/export_tabular_by_insight_id.md +++ b/docs/content/en/docs/execution/exports/export_tabular_by_insight_id.md @@ -28,14 +28,17 @@ The ID of the GoodData Workspace. {{< parameter p_name="insight_id" p_type="string" >}} The ID of the GoodData Insight. {{< /parameter >}} +{{< parameter p_name="file_format" p_type="string" >}} +The format of the file to be exported. +{{< /parameter >}} {{< parameter p_name="file_name" p_type="String" >}} -The name of the PDF file (excluding the file extension). Defaults to Path.cwd() +The name which the exported file should have. Defaults to None. {{< /parameter >}} {{< parameter p_name="settings" p_type="Optional[ExportSettings]" >}} -Configuration settings for the export. Defaults to None. +Any additional settings for the export. Defaults to None. {{< /parameter >}} {{< parameter p_name="store_path" p_type="Union[String, Path]" >}} -The name of the PDF file (excluding the file extension). Defaults to Path.cwd() +The path to store the exported file. Defaults to Path.cwd(). {{< /parameter >}} {{< parameter p_name="timeout" p_type="float" >}} The maximum amount of time (in seconds) to wait for the server to process the export. Defaults to 60.0. diff --git a/gooddata-sdk/gooddata_sdk/catalog/export/service.py b/gooddata-sdk/gooddata_sdk/catalog/export/service.py index 8a113fd42..f104e7786 100644 --- a/gooddata-sdk/gooddata_sdk/catalog/export/service.py +++ b/gooddata-sdk/gooddata_sdk/catalog/export/service.py @@ -297,8 +297,9 @@ def export_tabular_by_insight_id( settings (Optional[ExportSettings], optional): Any additional settings for the export. Defaults to None. store_path (Union[str, Path], optional): The path to store the exported file. Defaults to Path.cwd(). timeout (float, optional): The maximum time to wait for the export to finish. Defaults to 60.0. - retry (float, optional): The time to wait before attempting to retry the export. Defaults to 0.2. - max_retry (float, optional): The maximum number of times to retry the export. Defaults to 5.0. + retry (float, optional): + Initial wait time (in seconds) before retrying to get the exported content. Defaults to 0.2. + max_retry (float, optional): The maximum retry wait time (in seconds). Defaults to 5.0. Returns: None