Documentation Source Text

Check-in [5b698017df]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Update zipfile documentation to include using the table-valued function to read an in-memory zip archive.
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256:5b698017dfb2bd3576b1f98f23e648ed55a141225d5c78eebbe8cfb9cb1532b0
User & Date: dan 2018-01-27 20:56:33
Context
2018-01-29
17:17
Fix an XSS problem in the search function on the website. check-in: 90f86ae4c5 user: drh tags: trunk
2018-01-27
20:56
Update zipfile documentation to include using the table-valued function to read an in-memory zip archive. check-in: 5b698017df user: dan tags: trunk
2018-01-26
18:38
Update documentation for CAST to integer to describe what happens when the integer is too large. This behavior is only supported on the latest trunk, so with this check-in the documentation is no longer suitable for use with 3.22.0. check-in: 6b1b360098 user: drh tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to pages/zipfile.in.

50
51
52
53
54
55
56
57




58
59
60
61
62
63








64
65
66
67
68
69
70
archives. A table-valued function, which provides read-only access to
existing archives, and a virtual table interface, which provides both
read and write access.

<h2>Table-Valued Function (read-only access)</h2>

<p>For reading existing zip archives, the Zipfile module provides a
[table-valued function] that accepts a single argument - the path to the zip




archive to be read. For example, to inspect the contents of zip archive
"test.zip" from the current directory:

<codeblock>
  SELECT * FROM zipfile('test.zip');
</codeblock>









<p>The table-valued function returns one row for each record (file, 
directory or symbolic link) in the zip archive. Each row has the 
following columns:

<table striped=1>
<tr><th>Column&nbsp;Name<th>Contents







|
>
>
>
>
|
|




>
>
>
>
>
>
>
>







50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
archives. A table-valued function, which provides read-only access to
existing archives, and a virtual table interface, which provides both
read and write access.

<h2>Table-Valued Function (read-only access)</h2>

<p>For reading existing zip archives, the Zipfile module provides a
[table-valued function] that accepts a single argument. If the argument
is a text value, then it is a path to a zip archive to read from the
file-system. Or, if the argument is an SQL blob, then it is the zip
archive data itself.

<p>For example, to inspect the contents of zip archive "test.zip" from 
the current directory:

<codeblock>
  SELECT * FROM zipfile('test.zip');
</codeblock>

<p>Or, from the SQLite shell tool (the [file I/O functions|readfile()] 
function reads the contents of a file from the file-system and returns it as a
blob):

<codeblock>
  SELECT * FROM zipfile( readfile('test.zip') );
</codeblock>

<p>The table-valued function returns one row for each record (file, 
directory or symbolic link) in the zip archive. Each row has the 
following columns:

<table striped=1>
<tr><th>Column&nbsp;Name<th>Contents