Skip to main content

S3_File.read

readformaton_problems

Group: Input
Aliases: load, open

Documentation​

Read a file using the specified file format

Arguments​

  • format: A File_Format object used to read file into memory. If Auto_Detect is specified; the provided file determines the specific type and configures it appropriately.
  • on_problems: Specifies the behavior when a problem occurs during the function. By default, a warning is issued, but the operation proceeds. If set to Report_Error, the operation fails with a dataflow error. If set to Ignore, the operation proceeds without errors or warnings.

Returns​

  • The contents of the file read using the specified File_Format.

Errors​

  • If the bucket does not exist, an S3_Bucket_Not_Found error is thrown.
  • If the target is a directory, an Illegal_Argument error is thrown.
  • If the file does not exist, a File_Error.Not_Found error is thrown.
  • If the access to the object is forbidden, an S3_Error.Access_Denied error is thrown.
  • If using Auto_Detect, and there is no matching type then a File_Error.Unsupported_Type error is returned.