I/O Functions - Spiral Docs

This page lists 13 functions in the spql.io namespace generated from the default SPQL function catalog.

Function	Kind	Summary
`spql.io.blob`	scalar function	Construct an external Blob without reading bytes.
`spql.io.bytes`	scalar function	Return a Blob’s inline bytes.
`spql.io.etag`	scalar function	Return a Blob’s ETag.
`spql.io.generation`	scalar function	Return a Blob’s object generation.
`spql.io.inline_blob`	scalar function	Construct an inline Blob from binary bytes.
`spql.io.md5`	scalar function	Return a Blob’s MD5 digest.
`spql.io.mime_type`	scalar function	Return a Blob’s MIME type.
`spql.io.offset`	scalar function	Return a Blob’s byte offset.
`spql.io.sha1`	scalar function	Return a Blob’s SHA-1 digest.
`spql.io.sha256`	scalar function	Return a Blob’s SHA-256 digest.
`spql.io.size`	scalar function	Return a Blob’s byte size.
`spql.io.uri`	scalar function	Return a Blob’s external URI.
`spql.io.version_id`	scalar function	Return a Blob’s object version id.

`spql.io.blob`

Kind: scalar function

Construct an external Blob without reading bytes.

Signature

spql.io.blob(uri, offset?, size?, mime_type?, etag?, version_id?, generation?, md5?, sha1?, sha256?)

Parameters

Name	Required	Description
`uri`	yes	No parameter docs.
`offset`	no	No parameter docs.
`size`	no	No parameter docs.
`mime_type`	no	No parameter docs.
`etag`	no	No parameter docs.
`version_id`	no	No parameter docs.
`generation`	no	No parameter docs.
`md5`	no	No parameter docs.
`sha1`	no	No parameter docs.
`sha256`	no	No parameter docs.

`spql.io.bytes`

Kind: scalar function

Return a Blob’s inline bytes.

Signature

spql.io.bytes(blob)

Parameters

Name	Required	Description
`blob`	yes	No parameter docs.

`spql.io.etag`

Kind: scalar function

Return a Blob’s ETag.

Signature

spql.io.etag(blob)

Parameters

Name	Required	Description
`blob`	yes	No parameter docs.

`spql.io.generation`

Kind: scalar function

Return a Blob’s object generation.

Signature

spql.io.generation(blob)

Parameters

Name	Required	Description
`blob`	yes	No parameter docs.

`spql.io.inline_blob`

Kind: scalar function

Construct an inline Blob from binary bytes.

Signature

spql.io.inline_blob(bytes, size?, mime_type?, md5?, sha1?, sha256?)

Parameters

Name	Required	Description
`bytes`	yes	No parameter docs.
`size`	no	No parameter docs.
`mime_type`	no	No parameter docs.
`md5`	no	No parameter docs.
`sha1`	no	No parameter docs.
`sha256`	no	No parameter docs.

`spql.io.md5`

Kind: scalar function

Return a Blob’s MD5 digest.

Signature

spql.io.md5(blob)

Parameters

Name	Required	Description
`blob`	yes	No parameter docs.

`spql.io.mime_type`

Kind: scalar function

Return a Blob’s MIME type.

Signature

spql.io.mime_type(blob)

Parameters

Name	Required	Description
`blob`	yes	No parameter docs.

`spql.io.offset`

Kind: scalar function

Return a Blob’s byte offset.

Signature

spql.io.offset(blob)

Parameters

Name	Required	Description
`blob`	yes	No parameter docs.

`spql.io.sha1`

Kind: scalar function

Return a Blob’s SHA-1 digest.

Signature

spql.io.sha1(blob)

Parameters

Name	Required	Description
`blob`	yes	No parameter docs.

`spql.io.sha256`

Kind: scalar function

Return a Blob’s SHA-256 digest.

Signature

spql.io.sha256(blob)

Parameters

Name	Required	Description
`blob`	yes	No parameter docs.

`spql.io.size`

Kind: scalar function

Return a Blob’s byte size.

Signature

spql.io.size(blob)

Parameters

Name	Required	Description
`blob`	yes	No parameter docs.

`spql.io.uri`

Kind: scalar function

Return a Blob’s external URI.

Signature

spql.io.uri(blob)

Parameters

Name	Required	Description
`blob`	yes	No parameter docs.

`spql.io.version_id`

Kind: scalar function

Return a Blob’s object version id.

Signature

spql.io.version_id(blob)

Parameters

Name	Required	Description
`blob`	yes	No parameter docs.