Introduction

Enzo Server
  Installation
  Quick Start
  Core Features
    Async Calls
    ConnectionStrings
    Edge Cache
    HTTP Access
    Scheduling
    Views
  Advanced Capabilities
    Change Data Capture
  Administration
    Configuration Settings
    Logins & ACL
    Auditing
    Current Executions
    Linked Server
    SSL

  User Guides
     Sharding
     Sharding Overview

     SharePoint

   Adapters
    All Adapters


  SDK
    Overview
    Installation
    DevHost
    Create A Simple Adapter
    Best Practices
    Developer Guide
      Handler Columns
      Handler Options
      Handler Decorators
      Dynamic Columns
      Table & Table Enumerators
      Virtual Tables



Zip Adapter








The Zip adapter allows you to Zip and Unzip documents, content and set passwords using SQL and REST commands.




Configuration Settings



This adapter does not use configuration settings.



Handlers



compress
Compresses (ZIP) the content (or file) provided and returns the output as a binary array details 

Arguments

Name Description Default
content R The content (or file) to compress

SQL Call

exec Zip.compress 'This is a message to compress'
exec Zip.compress 'c:\tmp\myfile.txt'


Http Call

/bsc/zip/compress

Output Columns

Object outputThe compressed content
compressToFile
Compresses (ZIP) the content (or file) provided and creates a Zip file details 

Arguments

Name Description Default
content R The content (or file) to compress
fileName The output file name to create (creates a TMP file if left empty)
override When 1, overrides the output file False
password Password used to protect the Zip document (leave blank for no password)

SQL Call

exec Zip.compress 'This is a message to compress', 'c:\tmp\output.zip'
exec Zip.compress 'c:\tmp\myfile.txt', 'c:\tmp\output.zip', 1


Http Call

/bsc/zip/compresstofile

Output Columns

String targetFileName
String entryName
Int64 fileSize
Int64 compressedSize
list
List the contents of a file details 

Arguments

Name Description Default
fileName R Name of the file to list. Must include file extension.
path R Local or UNC path to file
password Password to use for reading

SQL Call

exec Zip.list 'test'


Http Call

/bsc/zip/list

Output Columns

This call does not return data.

uncompress
Uncompresses (UNZIP) the content (or file) provided and returns the output as a string details 

Arguments

Name Description Default
content R The zipped content (or file) to uncompress
password Optional password when the content is a password-protected file

SQL Call

exec Zip.uncompress '0x1F8B08000000000004002BC9C82C5600A2448592D4E21285DCD4E2E2C4F454005454DEA216000000'
exec Zip.uncompress 'c:\tmp\myfile.zip'


Http Call

/bsc/zip/uncompress

Output Columns

String outputThe uncompressed content as a string