Scp SQL Server Reference Documentation
Scp
Current Version: 11.6.0
Chilkat.Scp
Attach
Transfer local files to remote paths or download remote files to the
local filesystem using SCP.
Upload or download binary data, encoded data, text, or
Synchronize directory trees and use filtering options to include or
exclude selected files.
Set remote UNIX permissions, pass environment variables, and control
transfer-related behavior required by the remote server.
Monitor progress, scale progress percentages, abort active transfers, and
run supported operations as asynchronous tasks.
For an extended overview, see
Scp Class Overview.
Transfer files, text, and binary data over SCP using an existing SSH connection.
Chilkat.Scp is the Chilkat class for SCP file transfer over an
already-established Chilkat.Ssh connection. It supports
local-file upload and download, in-memory binary transfer, encoded binary
transfer, text transfer with explicit character sets, BinData
transfer, directory-tree synchronization, sync filtering, remote UNIX
permission overrides, environment variables, progress scaling, abort support,
and asynchronous task integration.
Uses an SSH connection
Scp to an authenticated Chilkat.Ssh
session rather than opening a separate network connection.
Upload and download files
Memory-based transfers
Chilkat.BinData without requiring temporary files.
Directory synchronization
Remote file options
Progress and async support
Chilkat.Ssh, initialize
Chilkat.Scp with that SSH connection, then upload, download, or
synchronize the desired files or in-memory data. Use Scp for
SCP-style transfers over SSH; use Chilkat.SFtp when the remote
server expects the SFTP protocol instead.
Object Creation
DECLARE @hr int
DECLARE @scp int
EXEC @hr = sp_OACreate 'Chilkat.Scp', @scp OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- ... use @scp ...
EXEC @hr = sp_OADestroy @scpT-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as sp_OACreate 'Chilkat.Scp.11' for Chilkat v11.*.*.
sp_OACreate returns an object token (an int) that is passed as the first argument of every sp_OAMethod, sp_OAGetProperty and sp_OASetProperty call, and released with sp_OADestroy. Objects returned by methods (such as an HttpResponse or JsonObject) are also tokens received through an int OUT parameter; they must likewise be destroyed, and the OUT parameter is NULL when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero @hr), sp_OAGetErrorInfo describes the error.
Data types: strings are nvarchar(4000); integers, booleans (1 or 0) and object tokens are int; dates are datetime. In the signatures on this page, @success, @iResult, @sResult and the like are the OUT variables receiving a method's return value, @iValue / @sValue receive or supply a property value, and the remaining @ variables are the method's arguments in order.
A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example DECLARE @tmp TABLE (outputLine ntext) followed by INSERT INTO @tmp EXEC sp_OAGetProperty @scp, 'LastErrorText'. See string length limitations for strings returned by sp_OAMethod calls.
Methods that pass or return raw byte arrays are not shown on this page, because varbinary(max) values cannot be exchanged through sp_OAMethod (see varbinary(max) limitation). Use the BinData-based alternatives (methods ending in Bd) or the base64 / hex string-encoded variants instead. Binary properties (such as LastBinaryResult) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*Async) methods and event callbacks are not available from SQL Server.
Properties
AbortCurrent
EXEC sp_OASetProperty @scp, 'AbortCurrent', @iValue
Set to 1 to request cancellation of the method currently executing on this object. Long-running network and file-transfer operations check this property periodically; a method that completes quickly may finish before the request is observed.
Both synchronous and asynchronous operations can be cancelled. To cancel a synchronous call, set this property from another thread on the same Scp object. Chilkat resets the property to 0 after the cancellation is processed. If no method is running, a previously set value is cleared when the next method begins.
LastMethodSuccess where applicable, and LastErrorText to determine the final outcome.DebugLogFilePath
EXEC sp_OASetProperty @scp, 'DebugLogFilePath', @sValue
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
EXEC sp_OASetProperty @scp, 'LastMethodSuccess', @iValue
Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topSendEnv
EXEC sp_OASetProperty @scp, 'SendEnv', @sValue
Specifies environment variables to send for each SCP upload or download. Set the property to a JSON object whose member names are environment-variable names and whose values are strings.
{
"LCS_PASSWORD": "myPassword",
"SOME_ENV_VAR": "some_value"
}
SyncedFiles
EXEC sp_OASetProperty @scp, 'SyncedFiles', @sValue
Contains the local paths of the files transferred by the most recent call to SyncTreeUpload or SyncTreeDownload. Paths are listed one per line.
- After an upload, each line is the full local path of a source file that was uploaded.
- After a download, each line is the full local path of a destination file that was downloaded.
SyncMustMatch
EXEC sp_OASetProperty @scp, 'SyncMustMatch', @sValue
Specifies a semicolon-separated list of wildcard patterns for filenames that are eligible for transfer by SyncTreeUpload and SyncTreeDownload. A file is considered only when its filename matches at least one pattern.
For example, *.xml;*.txt;*.csv limits synchronization to XML, text, and CSV files. The default empty string imposes no include restriction.
SyncMustMatchDir and SyncMustNotMatchDir.SyncMustMatchDir
EXEC sp_OASetProperty @scp, 'SyncMustMatchDir', @sValue
Specifies a semicolon-separated list of wildcard patterns for directory names that may be traversed by SyncTreeUpload and SyncTreeDownload. When this property is nonempty, synchronization descends only into directories whose names match at least one pattern.
For example, a*;b*;c* permits traversal into directories whose names begin with a, b, or c. The default empty string permits traversal into all directories, subject to SyncMustNotMatchDir.
SyncMustNotMatch
EXEC sp_OASetProperty @scp, 'SyncMustNotMatch', @sValue
Specifies a semicolon-separated list of wildcard patterns for filenames that must be skipped by SyncTreeUpload and SyncTreeDownload.
For example, *.tmp;*.bak;*.log excludes temporary, backup, and log files. The default empty string excludes no files.
SyncMustNotMatchDir to prevent synchronization from entering selected directories and their subtrees.SyncMustNotMatchDir
EXEC sp_OASetProperty @scp, 'SyncMustNotMatchDir', @sValue
Specifies a semicolon-separated list of wildcard patterns for directory names that must not be traversed by SyncTreeUpload and SyncTreeDownload. A matching directory and everything below it are skipped.
For example, temp*;cache*;.git prevents traversal into temporary, cache, and Git metadata directories. The default empty string excludes no directories.
UncommonOptions
EXEC sp_OASetProperty @scp, 'UncommonOptions', @sValue
Provides a comma-separated list of specialized compatibility options. The default is the empty string, which is appropriate for normal SCP transfers.
| Keyword | Behavior |
|---|---|
FilenameOnly | Uses only the filename, rather than the complete target path, in the remote scp -t command. This option exists for compatibility with systems such as certain LANCOM routers. |
ProtectFromVpn | On Android, attempts to route the SCP connection outside an installed or active VPN. |
UnixPermOverride
EXEC sp_OASetProperty @scp, 'UnixPermOverride', @sValue
Specifies an octal UNIX permission mode to apply to files uploaded by SCP, overriding the permissions derived from the local source file. For example, set this property to 0644 to grant read/write permission to the owner and read-only permission to the group and others.
The default is the empty string, which causes the uploaded file's remote permissions to be based on the local file's permissions.
0600, 0644, or 0755. The remote SSH account must still have permission to create or replace the file, and server-side policy may restrict the final mode.VerboseLogging
EXEC sp_OASetProperty @scp, 'VerboseLogging', @iValue
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
DownloadBd
Downloads the file at remotePath and appends its exact bytes to the existing contents of the BinData object in bd.
An absolute remote path begins with /. A relative path is interpreted relative to the authenticated SSH user's home directory.
bd before downloading. Clear the BinData object first when the downloaded file should replace, rather than follow, its current contents.Returns 1 for success, 0 for failure.
topDownloadBinaryEncoded
Downloads the file at remotePath and returns its bytes encoded as text using the binary encoding named by encoding, such as base64 or hex.
An absolute remote path begins with /. A relative path is interpreted relative to the authenticated SSH user's home directory.
encoding selects a text representation of arbitrary bytes; it is not a character set and does not decode the remote file as text. Use DownloadString when the remote file contains text that must be decoded with a charset.Returns NULL on failure
DownloadFile
Downloads the file at remotePath from the SSH server and writes its bytes to the local filesystem path in localPath.
An absolute remote path begins with /. A relative remote path is interpreted relative to the authenticated SSH user's home directory. The application must have permission to create or replace the local destination file.
Returns 1 for success, 0 for failure.
DownloadString
Downloads the file at remotePath, decodes its bytes using the character encoding named by charset, and returns the resulting text.
An absolute remote path begins with /. A relative path is interpreted relative to the authenticated SSH user's home directory.
charset describes how the remote file’s bytes represent characters, for example utf-8, windows-1252, or iso-8859-1. Using the wrong charset can produce incorrect characters. Use a binary download method for files that are not text.Returns NULL on failure
SyncTreeDownload
Synchronizes files from the remote directory tree rooted at remoteRoot to the local directory rooted at localRoot. bRecurse controls recursion: set it to 1 to descend into subdirectories, or 0 to process only files directly in the root directory.
An absolute remote root begins with /; a relative remote root is interpreted relative to the authenticated SSH user's home directory. A relative local root is interpreted relative to the application's current working directory.
| Mode | Files transferred |
|---|---|
0 | Download every eligible file. |
1 | Download files that do not already exist locally. |
2 | Download files that are missing locally or whose remote last-modified time is newer than the local file. |
3 | Download only files whose remote last-modified time is newer. A remote file that has no local counterpart is not downloaded. |
5 | Download files that are missing locally or whose size differs from the local file. |
6 | Download files that are missing locally, differ in size, or have a newer remote last-modified time. |
The filename and directory filters in SyncMustMatch, SyncMustNotMatch, SyncMustMatchDir, and SyncMustNotMatchDir are applied during traversal. After completion, SyncedFiles lists the full local paths of files actually downloaded.
2, 3, and 6 compare last-modified times. Incorrect server timestamps or clock differences between systems can affect which file is considered newer.Returns 1 for success, 0 for failure.
SyncTreeUpload
Synchronizes files from the local directory tree rooted at localBaseDir to the remote directory rooted at remoteBaseDir. bRecurse controls recursion: set it to 1 to descend into subdirectories, or 0 to process only files directly in the local base directory.
A relative local base directory is interpreted relative to the application's current working directory. An absolute remote base directory begins with /; a relative remote base directory is interpreted relative to the authenticated SSH user's home directory.
| Mode | Files transferred |
|---|---|
0 | Upload every eligible file. |
1 | Upload files that do not already exist on the remote server. |
2 | Upload files that are missing remotely or whose local last-modified time is newer than the remote file. |
3 | Upload only files whose local last-modified time is newer. A local file that has no remote counterpart is not uploaded. |
4 | Upload files that are missing remotely or whose size differs from the remote file. |
5 | Upload files that are missing remotely, differ in size, or have a newer local last-modified time. |
The filename and directory filters in SyncMustMatch, SyncMustNotMatch, SyncMustMatchDir, and SyncMustNotMatchDir are applied during traversal. After completion, SyncedFiles lists the full local paths of files actually uploaded.
2, 3, and 5 compare last-modified times. Incorrect server timestamps or clock differences between systems can affect which file is considered newer.Returns 1 for success, 0 for failure.
topUploadBd
Uploads all bytes currently contained in the BinData object in bd to the remote file at remotePath. The data is transferred without character decoding or other transformation.
An absolute remote path begins with /. A relative path is interpreted relative to the authenticated SSH user's home directory. The remote parent directory must already exist.
bd and does not remove or modify those bytes.Returns 1 for success, 0 for failure.
topUploadBinaryEncoded
Decodes the text in encodedData using the binary encoding named by encoding, then uploads the resulting bytes to the remote file at remotePath. Typical encoding names include base64 and hex.
An absolute remote path begins with /. A relative path is interpreted relative to the authenticated SSH user's home directory. The remote parent directory must already exist.
encoding is base64, Chilkat Base64-decodes encodedData and transfers the decoded binary bytes. This method is for encoded binary representations, not character-set conversion.Returns 1 for success, 0 for failure.
UploadFile
Uploads the local filesystem file at localPath to the remote path in remotePath. The file is transferred as raw bytes.
An absolute remote path begins with /. A relative remote path is interpreted relative to the authenticated SSH user's home directory. The remote parent directory must already exist, and the SSH account must have permission to create or replace the destination file.
Remote permissions are normally derived from the local file. Set UnixPermOverride when a specific remote UNIX mode is required.
UploadFile copies the file bytes without line-ending or character-set conversion.Returns 1 for success, 0 for failure.
UploadString
Encodes the text in textData using the character encoding named by charset, then uploads the resulting bytes to the remote file at remotePath.
An absolute remote path begins with /. A relative path is interpreted relative to the authenticated SSH user's home directory. The remote parent directory must already exist.
charset controls how characters are converted to bytes, for example utf-8, windows-1252, or iso-8859-1. SCP itself has no text mode; any line-ending characters already present in textData are encoded and transferred as part of the text.Returns 1 for success, 0 for failure.
UseSsh
Associates this Scp object with the connected and authenticated Ssh object in sshConnection. Subsequent SCP operations use that existing SSH session rather than opening a separate network connection.
Connection, proxy, timeout, host-key verification, algorithm, logging, and other transport-related settings belong to the Ssh object and therefore apply to the SCP operations performed through it. Keep the SSH object connected and available for as long as the Scp object is using it.
Scp performs SCP-style transfers over SSH and requires compatible SCP support on the remote system. Use Chilkat.SFtp when the server expects the SSH File Transfer Protocol subsystem or when directory listing and remote file-management features are needed.Returns 1 for success, 0 for failure.
top