Skip to main content
Vane Data / Reference

decode_image

decode_image decodes the first image from PNG/JPEG/TIFF/GIF/BMP/WebP bytes. mode=None preserves the encoded pixel mode; the default converts to RGB.

Signature

example.py
vane.decode_image(bytes_expr, on_error="raise", mode="RGB") -> Expression

SQL: decode_image(bytes, on_error => ..., mode => ...). Expression method: expr.decode_image(...).

Parameters

NameTypeDescriptionDefault
bytes_exprBLOB value or ExpressionEncoded image bytesRequired
on_error"raise" / "null""null" suppresses only malformed or unsupported content"raise"
modeMode name, ImageMode, Expression, or NoneResult pixel mode"RGB"

Returns and errors

Returns a dynamic IMAGE, or IMAGE(mode) for a constant mode. NULL returns NULL. Only malformed or unsupported content follows on_error="null"; other failures propagate.

Example

example.py
import vane


con = vane.connect()
data = open("photo.png", "rb").read()
con.sql("SELECT decode_image($1)", params=[data]).show()