Skip to main content
FieldDescriptionExample ValueType
bucket_name requiredS3 bucket name (without s3:// prefix). Combined with path_prefix to form the full S3 path. Example: bucket_name="my-bucket", path_prefix="data/" results in s3://my-bucket/data/"my-data-warehouse"String
region requiredAWS region where bucket is hosted"us-east-1"String
path_prefixOptional path prefix to filter files (without leading/trailing slashes)"data"String
access_key_idAWS access key ID (optional - see note below)"<YOUR_KEY>"String
secret_access_keyAWS secret access key (optional - see note below)"<YOUR_SECRET>"String
endpointCustom S3 endpoint for MinIO/LocalStack (required for non-AWS)"http://localhost:9000"String
file_format requiredFormat of files to sync: csv, json, or parquet"parquet"String
max_threadsMaximum number of concurrent file processors10Integer
retry_countNumber of retry attempts for failed operations3Integer
csvCSV-specific configuration object (see CSV Format tab){"has_header": true, "delimiter": ","}Object
jsonJSON-specific configuration object (see JSON Format tab){"line_delimited": true}Object


πŸ’‘ Join the OLake Community!

Got questions, ideas, or just want to connect with other data engineers?
πŸ‘‰ Join our Slack Community to get real-time support, share feedback, and shape the future of OLake together. πŸš€

Your success with OLake is our priority. Don’t hesitate to contact us if you need any help or further clarification!