Git Integration Procedures

repoFolder

In

string

No

System path where the repository will be initialized

result

Out

string

No

Result of the operation

branch

In

string

Yes

Branch name Git will use. If omitted, the procedure will return the current branch

tag

In

string

Yes

The tag name to checkout. It is mutually exclusive with a branch parameter. When doing a checkout of a tag, it is recommended to avoid creating new objects in the server

result

Out

string

No

Result of the operation if branch is set; current branch in case it is omitted

remoteUrl

In

string

No

URL of the remote repository in the SSH format (usually git @ remote- url.com:user/repo.git)

repoFolder

In

string

No

System path the repo should be cloned into

sshKeyId

In

integer

No

SSH key ID to be used as authentication in the remote repository. See documentation for the SYSADMIN_VDB.createSSHKeyPair procedure for SSH key generation

branchToCheckout

In

string

Yes

Branch to be checked out. If omitted, the master branch will be used

result

Out

string

No

Result of the operation

objectOrPattern

In

string

No

The object name(s) or pattern(s) (SQL LIKE) to be excluded during Git integration operations. Should be provided as a comma-separated list of values in the following format: object_type:object_name. Object type and pattern values are case insensitive.

replaceInsteadOfAppend

In

string

Yes

Changes the behaviour from appending new patterns to replacing the current exclude list with the objectPattern parameter value. Default: FALSE

result

Out

string

No

Result of the operation

objectTypes

In

string

Yes

Filter objects to be purge by type in CSV format.

Default: all.

Supported values: datasources, default options, schemas, procedures, views, optimizations, remarks, roles, permissions, users, queue handlers, jobs, optimization jobs, copy over table jobs, copy over sql jobs, gather statistics jobs, backup jobs, all jobs^*, recommended indexes, schedules, web business data shops, data catalog attributes

(*) The all jobs value allows purging all deletable jobs in one call (optimization, copy over, gather statistics, custom backup jobs, etc).

dryRun

In

boolean

Yes

• If set to TRUE, no change is done in the server but dry run of the operation is performed;

• If set to FALSE, all objects are purged.

Default: TRUE

ignorePurgeInGit

In

boolean

Yes

If set to TRUE, purging of objects is not reflected on Git files.

Default: FALSE

bypassGitExclude

In

boolean

Yes

If set to TRUE, purgeObjects will ignore the gitExclude list.

Default: FALSE

result

Out

string

No

Result of the operation

message

In

string

No

Message to be used in the commit operation

files

In

string

Yes

Array-formatted list of files to be committed. If omitted, the entire repository is committed

result

Out

string

No

Result of the commit operation containing the commit hash ID

status

ResultsSet

string

No

Status of the given file. Options are ADDED, CHANGED, REMOVED, MISSING, MODIFIED, UNTRACKED, and CONFLICTING

path

ResultsSet

string

No

Relative path of the file

file

In

string

No

Individual file to check the differences for

result

Out

string

No

Output of git diff for the requested file

file

In

string

No

File to check

strategy

In

string

No

Strategy to fix the conflict. Accepted values are OURS (to use the local file and discard remote changes) or THEIRS (to use the remote file and discard local changes)

result

Out

string

No

Result of the operation

result

Out

string

No

Result of the operation

result

Out

string

No

Result of the operation

additionalProperties

In

string

Yes

Allows to disable/enable atomic flag in git push. Default value of atomic flag: TRUE

remoteUrl

In

string

No

URL of the remote repository in the SSH format (usually git@remote- url.com:user/repo.git)

sshKeyId

In

integer

No

SSH key ID to be used as authentication in the remote repository. See documentation for the SYSADMIN_VDB.createSSHKeyPair procedure for SSH key generation

result

Out

string

No

Result of the operation

dryRun

In

boolean

Yes

If set, no actual task is performed in the CData Virtuality Server. The procedure will iterate all files and try to parse the SQL statements, but will not execute them

result

Out

string

No

Result of the operation

name

In

string

No

Name of the tag (like ‘1.0.0’)

message

In

string

No

Description of the tag and its details

result

Out

string

No

Result of the operation