# \HelpersApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**check_s3_folder_exists**](HelpersApi.md#check_s3_folder_exists) | **GET** /w/{workspace}/job_helpers/check_s3_folder_exists | Check if S3 path exists and is a folder
[**dataset_storage_test_connection**](HelpersApi.md#dataset_storage_test_connection) | **GET** /w/{workspace}/job_helpers/test_connection | Test connection to the workspace object storage
[**delete_s3_file**](HelpersApi.md#delete_s3_file) | **DELETE** /w/{workspace}/job_helpers/delete_s3_file | Permanently delete file from S3
[**duckdb_connection_settings**](HelpersApi.md#duckdb_connection_settings) | **POST** /w/{workspace}/job_helpers/duckdb_connection_settings | Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
[**duckdb_connection_settings_v2**](HelpersApi.md#duckdb_connection_settings_v2) | **POST** /w/{workspace}/job_helpers/v2/duckdb_connection_settings | Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
[**file_download**](HelpersApi.md#file_download) | **GET** /w/{workspace}/job_helpers/download_s3_file | Download file from S3 bucket
[**file_download_parquet_as_csv**](HelpersApi.md#file_download_parquet_as_csv) | **GET** /w/{workspace}/job_helpers/download_s3_parquet_file_as_csv | Download file to S3 bucket
[**file_upload**](HelpersApi.md#file_upload) | **POST** /w/{workspace}/job_helpers/upload_s3_file | Upload file to S3 bucket
[**git_repo_viewer_file_upload**](HelpersApi.md#git_repo_viewer_file_upload) | **POST** /w/{workspace}/job_helpers/upload_git_repo_file_to_instance_storage | Upload a file to the instance storage gitrepos section for viewing
[**list_git_repo_files**](HelpersApi.md#list_git_repo_files) | **GET** /w/{workspace}/job_helpers/list_git_repo_files | List the file keys available in instance object storage with resource-based access control
[**list_stored_files**](HelpersApi.md#list_stored_files) | **GET** /w/{workspace}/job_helpers/list_stored_files | List the file keys available in a workspace object storage
[**load_csv_preview**](HelpersApi.md#load_csv_preview) | **GET** /w/{workspace}/job_helpers/load_csv_preview/{path} | Load a preview of a csv file
[**load_file_metadata**](HelpersApi.md#load_file_metadata) | **GET** /w/{workspace}/job_helpers/load_file_metadata | Load metadata of the file
[**load_file_preview**](HelpersApi.md#load_file_preview) | **GET** /w/{workspace}/job_helpers/load_file_preview | Load a preview of the file
[**load_git_repo_file_metadata**](HelpersApi.md#load_git_repo_file_metadata) | **GET** /w/{workspace}/job_helpers/load_git_repo_file_metadata | Load file metadata from instance storage with resource-based access control
[**load_git_repo_file_preview**](HelpersApi.md#load_git_repo_file_preview) | **GET** /w/{workspace}/job_helpers/load_git_repo_file_preview | Load a preview of a file from instance storage with resource-based access control
[**load_parquet_preview**](HelpersApi.md#load_parquet_preview) | **GET** /w/{workspace}/job_helpers/load_parquet_preview/{path} | Load a preview of a parquet file
[**load_table_row_count**](HelpersApi.md#load_table_row_count) | **GET** /w/{workspace}/job_helpers/load_table_count/{path} | Load the table row count
[**move_s3_file**](HelpersApi.md#move_s3_file) | **GET** /w/{workspace}/job_helpers/move_s3_file | Move a S3 file from one path to the other within the same bucket
[**polars_connection_settings**](HelpersApi.md#polars_connection_settings) | **POST** /w/{workspace}/job_helpers/polars_connection_settings | Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
[**polars_connection_settings_v2**](HelpersApi.md#polars_connection_settings_v2) | **POST** /w/{workspace}/job_helpers/v2/polars_connection_settings | Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
[**s3_resource_info**](HelpersApi.md#s3_resource_info) | **POST** /w/{workspace}/job_helpers/v2/s3_resource_info | Returns the s3 resource associated to the provided path, or the workspace default S3 resource



## check_s3_folder_exists

> models::CheckS3FolderExists200Response check_s3_folder_exists(workspace, file_key, marker_file)
Check if S3 path exists and is a folder

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**file_key** | **String** | S3 file key to check (e.g., gitrepos/{workspace_id}/u/user/resource/{commit_hash}) | [required] |
**marker_file** | Option<**String**> | If provided, the folder is only considered to exist when this exact sentinel file is present under file_key. Lets callers distinguish a fully populated folder from a partial upload.  |  |

### Return type

[**models::CheckS3FolderExists200Response**](checkS3FolderExists_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## dataset_storage_test_connection

> serde_json::Value dataset_storage_test_connection(workspace, storage)
Test connection to the workspace object storage

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**storage** | Option<**String**> |  |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_s3_file

> serde_json::Value delete_s3_file(workspace, file_key, storage)
Permanently delete file from S3

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**file_key** | **String** |  | [required] |
**storage** | Option<**String**> |  |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## duckdb_connection_settings

> models::DuckdbConnectionSettings200Response duckdb_connection_settings(workspace, duckdb_connection_settings_request)
Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**duckdb_connection_settings_request** | [**DuckdbConnectionSettingsRequest**](DuckdbConnectionSettingsRequest.md) | S3 resource to connect to | [required] |

### Return type

[**models::DuckdbConnectionSettings200Response**](duckdbConnectionSettings_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## duckdb_connection_settings_v2

> models::DuckdbConnectionSettingsV2200Response duckdb_connection_settings_v2(workspace, duckdb_connection_settings_v2_request)
Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**duckdb_connection_settings_v2_request** | [**DuckdbConnectionSettingsV2Request**](DuckdbConnectionSettingsV2Request.md) | S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used | [required] |

### Return type

[**models::DuckdbConnectionSettingsV2200Response**](duckdbConnectionSettingsV2_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## file_download

> std::path::PathBuf file_download(workspace, file_key, s3_resource_path, resource_type, storage)
Download file from S3 bucket

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**file_key** | **String** |  | [required] |
**s3_resource_path** | Option<**String**> |  |  |
**resource_type** | Option<**String**> |  |  |
**storage** | Option<**String**> |  |  |

### Return type

[**std::path::PathBuf**](std::path::PathBuf.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/octet-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## file_download_parquet_as_csv

> String file_download_parquet_as_csv(workspace, file_key, s3_resource_path, resource_type)
Download file to S3 bucket

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**file_key** | **String** |  | [required] |
**s3_resource_path** | Option<**String**> |  |  |
**resource_type** | Option<**String**> |  |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/csv

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## file_upload

> models::FileUpload200Response file_upload(workspace, body, file_key, file_extension, s3_resource_path, resource_type, storage, content_type, content_disposition)
Upload file to S3 bucket

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**body** | **std::path::PathBuf** | File content | [required] |
**file_key** | Option<**String**> |  |  |
**file_extension** | Option<**String**> |  |  |
**s3_resource_path** | Option<**String**> |  |  |
**resource_type** | Option<**String**> |  |  |
**storage** | Option<**String**> |  |  |
**content_type** | Option<**String**> |  |  |
**content_disposition** | Option<**String**> |  |  |

### Return type

[**models::FileUpload200Response**](fileUpload_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/octet-stream
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## git_repo_viewer_file_upload

> models::FileUpload200Response git_repo_viewer_file_upload(workspace, body, file_key, file_extension, s3_resource_path, resource_type, storage, content_type, content_disposition)
Upload a file to the instance storage gitrepos section for viewing

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**body** | **std::path::PathBuf** | File content | [required] |
**file_key** | Option<**String**> |  |  |
**file_extension** | Option<**String**> |  |  |
**s3_resource_path** | Option<**String**> |  |  |
**resource_type** | Option<**String**> |  |  |
**storage** | Option<**String**> |  |  |
**content_type** | Option<**String**> |  |  |
**content_disposition** | Option<**String**> |  |  |

### Return type

[**models::FileUpload200Response**](fileUpload_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/octet-stream
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_git_repo_files

> models::ListStoredFiles200Response list_git_repo_files(workspace, max_keys, marker, prefix, storage)
List the file keys available in instance object storage with resource-based access control

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**max_keys** | **i32** |  | [required] |
**marker** | Option<**String**> |  |  |
**prefix** | Option<**String**> |  |  |
**storage** | Option<**String**> |  |  |

### Return type

[**models::ListStoredFiles200Response**](listStoredFiles_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_stored_files

> models::ListStoredFiles200Response list_stored_files(workspace, max_keys, marker, prefix, storage)
List the file keys available in a workspace object storage

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**max_keys** | **i32** |  | [required] |
**marker** | Option<**String**> |  |  |
**prefix** | Option<**String**> |  |  |
**storage** | Option<**String**> |  |  |

### Return type

[**models::ListStoredFiles200Response**](listStoredFiles_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## load_csv_preview

> load_csv_preview(workspace, path, offset, limit, sort_col, sort_desc, search_col, search_term, storage, csv_separator)
Load a preview of a csv file

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**offset** | Option<**f64**> |  |  |
**limit** | Option<**f64**> |  |  |
**sort_col** | Option<**String**> |  |  |
**sort_desc** | Option<**bool**> |  |  |
**search_col** | Option<**String**> |  |  |
**search_term** | Option<**String**> |  |  |
**storage** | Option<**String**> |  |  |
**csv_separator** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## load_file_metadata

> models::OrvantaFileMetadata load_file_metadata(workspace, file_key, storage)
Load metadata of the file

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**file_key** | **String** |  | [required] |
**storage** | Option<**String**> |  |  |

### Return type

[**models::OrvantaFileMetadata**](OrvantaFileMetadata.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## load_file_preview

> models::OrvantaFilePreview load_file_preview(workspace, file_key, file_size_in_bytes, file_mime_type, csv_separator, csv_has_header, read_bytes_from, read_bytes_length, storage)
Load a preview of the file

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**file_key** | **String** |  | [required] |
**file_size_in_bytes** | Option<**i32**> |  |  |
**file_mime_type** | Option<**String**> |  |  |
**csv_separator** | Option<**String**> |  |  |
**csv_has_header** | Option<**bool**> |  |  |
**read_bytes_from** | Option<**i32**> |  |  |
**read_bytes_length** | Option<**i32**> |  |  |
**storage** | Option<**String**> |  |  |

### Return type

[**models::OrvantaFilePreview**](OrvantaFilePreview.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## load_git_repo_file_metadata

> models::OrvantaFileMetadata load_git_repo_file_metadata(workspace, file_key, storage)
Load file metadata from instance storage with resource-based access control

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**file_key** | **String** |  | [required] |
**storage** | Option<**String**> |  |  |

### Return type

[**models::OrvantaFileMetadata**](OrvantaFileMetadata.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## load_git_repo_file_preview

> models::OrvantaFilePreview load_git_repo_file_preview(workspace, file_key, file_size_in_bytes, file_mime_type, csv_separator, csv_has_header, read_bytes_from, read_bytes_length, storage)
Load a preview of a file from instance storage with resource-based access control

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**file_key** | **String** |  | [required] |
**file_size_in_bytes** | Option<**i32**> |  |  |
**file_mime_type** | Option<**String**> |  |  |
**csv_separator** | Option<**String**> |  |  |
**csv_has_header** | Option<**bool**> |  |  |
**read_bytes_from** | Option<**i32**> |  |  |
**read_bytes_length** | Option<**i32**> |  |  |
**storage** | Option<**String**> |  |  |

### Return type

[**models::OrvantaFilePreview**](OrvantaFilePreview.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## load_parquet_preview

> load_parquet_preview(workspace, path, offset, limit, sort_col, sort_desc, search_col, search_term, storage)
Load a preview of a parquet file

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**offset** | Option<**f64**> |  |  |
**limit** | Option<**f64**> |  |  |
**sort_col** | Option<**String**> |  |  |
**sort_desc** | Option<**bool**> |  |  |
**search_col** | Option<**String**> |  |  |
**search_term** | Option<**String**> |  |  |
**storage** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## load_table_row_count

> models::LoadTableRowCount200Response load_table_row_count(workspace, path, search_col, search_term, storage)
Load the table row count

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**search_col** | Option<**String**> |  |  |
**search_term** | Option<**String**> |  |  |
**storage** | Option<**String**> |  |  |

### Return type

[**models::LoadTableRowCount200Response**](loadTableRowCount_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## move_s3_file

> serde_json::Value move_s3_file(workspace, src_file_key, dest_file_key, storage)
Move a S3 file from one path to the other within the same bucket

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**src_file_key** | **String** |  | [required] |
**dest_file_key** | **String** |  | [required] |
**storage** | Option<**String**> |  |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## polars_connection_settings

> models::PolarsConnectionSettings200Response polars_connection_settings(workspace, duckdb_connection_settings_request)
Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**duckdb_connection_settings_request** | [**DuckdbConnectionSettingsRequest**](DuckdbConnectionSettingsRequest.md) | S3 resource to connect to | [required] |

### Return type

[**models::PolarsConnectionSettings200Response**](polarsConnectionSettings_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## polars_connection_settings_v2

> models::PolarsConnectionSettingsV2200Response polars_connection_settings_v2(workspace, duckdb_connection_settings_v2_request)
Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**duckdb_connection_settings_v2_request** | [**DuckdbConnectionSettingsV2Request**](DuckdbConnectionSettingsV2Request.md) | S3 resource path to use to generate the connection settings. If empty, the S3 resource defined in the workspace settings will be used | [required] |

### Return type

[**models::PolarsConnectionSettingsV2200Response**](polarsConnectionSettingsV2_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## s3_resource_info

> models::S3Resource s3_resource_info(workspace, duckdb_connection_settings_v2_request)
Returns the s3 resource associated to the provided path, or the workspace default S3 resource

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**duckdb_connection_settings_v2_request** | [**DuckdbConnectionSettingsV2Request**](DuckdbConnectionSettingsV2Request.md) | S3 resource path to use. If empty, the S3 resource defined in the workspace settings will be used | [required] |

### Return type

[**models::S3Resource**](S3Resource.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

