Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.


Opens the file found at path filename, and reads the entire file. Returns the file as an array of bytes. Commonly this array of bytes is uploaded to a database table with a column of type BLOB (Binary Large OBject). This upload would be done through an INSERT or UPDATE SQL statement run through the system.db.runPrepUpdate function. You could also write the bytes to another file using the system.file.writeFile function, or send the bytes as an email attachment using

Client Permission Restrictions

This scripting function has no Client Permission restrictions.



  • Parameters

String filepath - The path of the file to read.

  • Returns

byte[] - The contents of the file as an array of bytes.

  • Scope


Code Examples
Code Snippet
# This code would prompt the user to choose a file. If the user chooses a file, it would then read that file and upload it to a database table called Files into a BLOB column called file_data.
path = system.file.openFile()
if path != None:
   bytes = system.file.readFileAsBytes(path)
   system.db.runPrepUpdate("INSERT INTO Files (file_data) VALUES (?)", [bytes])
  • No labels