{"id":921,"date":"2021-07-27T15:06:31","date_gmt":"2021-07-27T15:06:31","guid":{"rendered":"https:\/\/www.versionsql.com\/help\/documentation\/connection-settings\/advanced-options\/"},"modified":"2025-10-01T14:39:28","modified_gmt":"2025-10-01T14:39:28","slug":"advanced-options","status":"publish","type":"docs","link":"https:\/\/www.versionsql.com\/help\/documentation\/connection-settings\/advanced-options\/","title":{"rendered":"Advanced Options"},"content":{"rendered":"<p>Settings that aren&#8217;t critical for getting started, but can be useful in certain situations.<\/p>\n<h2>Connection<\/h2>\n<h3>Clear Stored Credentials<\/h3>\n<p>For Git and Subversion connections, removes any cached credentials for the current connection or path.<\/p>\n<p>If you authenticated via OAuth, this will clear the token from VersionSQL&#8217;s cache. However, your browser may still log you in automatically from <em>its<\/em> cache. To log in as a different OAuth user, log out of your version control system from your web browser before clicking Clear Stored Credentials.<\/p>\n<h3>Disconnect from Version Control<\/h3>\n<p>Deletes the connection settings file from your computer.<\/p>\n<h3>Import\/Export Connection<\/h3>\n<p>Migrate your connection settings to and from a file.\u00a0 Makes it easier to share configuration between environments or team members.<\/p>\n<h2>Scripting<\/h2>\n<h3>Root Directory<\/h3>\n<p>By default, VersionSQL creates a <code>VersionSQL<\/code> subfolder inside your repository, and layers in the SQL within that. Use this setting to rename that folder.<\/p>\n<h3>Include server name and instance name in path<\/h3>\n<p>The default folder structure ensures that similarly-named databases across different servers are tracked independently without conflicts. If that isn&#8217;t relevant in your situation, or you <em>want<\/em> databases on different servers to share the same repo paths, uncheck this box.<\/p>\n<ul>\n<li>Checked (default):\n<ul>\n<li><code>\/VersionSQL\/pc_name\/db_server_name\/db_name\/obj_schema\/obj_type\/obj_name.sql<\/code><\/li>\n<\/ul>\n<\/li>\n<li>Unchecked:\n<ul>\n<li><code>\/VersionSQL\/db_name\/obj_schema\/obj_type\/obj_name.sql<\/code><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h3>Include database name in path<\/h3>\n<p>The default folder structure ensures that different databases on the same server are tracked independently without conflicts. If you will only commit a single database to this repo, uncheck this box.<\/p>\n<ul>\n<li>Checked (default):\n<ul>\n<li><code>\/VersionSQL\/db_name\/obj_schema\/obj_type\/obj_name.sql<\/code><\/li>\n<\/ul>\n<\/li>\n<li>Unchecked:\n<ul>\n<li><code>\/VersionSQL\/obj_schema\/obj_type\/obj_name.sql<\/code><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h3>Put Schema in File Name Instead of Path<\/h3>\n<p>Enable this option to prepend the database schema to the file name, rather than including it as a separate folder in the file path.<\/p>\n<ul>\n<li>Checked:\n<ul>\n<li><code>...\/db_name\/obj_type\/obj_schema.obj_name.sql<\/code><\/li>\n<\/ul>\n<\/li>\n<li>Unchecked (default):<\/li>\n<li style=\"list-style-type: none;\">\n<ul>\n<li><code>...\/db_name\/obj_schema\/obj_type\/obj_name.sql<\/code><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h3>Path Compatibility Options<\/h3>\n<p>VersionSQL provides a list of path compatibility options for those importing repositories saved by other software.<\/p>\n<h2>Schedule<\/h2>\n<p>Enables automatic scheduled commits for this database.\u00a0 See\u00a0<a href=\"https:\/\/www.versionsql.com\/help\/documentation\/features\/automatic-scheduled-commits\/\">Automatic Scheduled Commits<\/a> for more details.<\/p>\n<h2>Static Data<\/h2>\n<p>Configures static data commits for this database.\u00a0 See <a href=\"https:\/\/www.versionsql.com\/help\/documentation\/features\/static-data-scripting\/\">Static Data Scripting<\/a> for more details.<\/p>\n<h2>Git Only<\/h2>\n<p>These settings only apply to connections using the <code>Git<\/code> repository type.<\/p>\n<h3>Branch<\/h3>\n<p>Specifies the existing git branch to use upon first connection.\u00a0 Provided as a time-saving measure.\u00a0 Alternatively, connect first and then switch the connection to the correct branch via the Switch Branch function under the VersionSQL context menu before committing.<br \/>\n<div class=\"wedocs-callout callout-yellow\">Important: The branch name specified here must already exist in the repository.<\/div><\/p>\n<h3>Git Author Information<\/h3>\n<p>Specify Git author credentials explicitly on a per-connection basis.\u00a0 If &#8220;Autodetect&#8221; is checked, VersionSQL will attempt to identify the user&#8217;s name and email from their account credentials and\/or Git global settings.<\/p>\n<h2>Folder Only<\/h2>\n<p>These settings only apply to connections using the <code>Folder<\/code> repository type.<\/p>\n<h3>Auto-close after-save command<\/h3>\n<p>Automatically close the command dialog that opens to run the after-save command. If this is unchecked, the command dialog will remain open.<\/p>\n<h3>Custom Menu Commands<\/h3>\n<p>Allows you to specify any number of custom commands to place in the VersionSQL context menu.<\/p>\n<h4>Preset<\/h4>\n<p>Several presets are provided.<\/p>\n<h4>Menu Text<\/h4>\n<p>The text to display in the VersionSQL context menu. Clicking that text will run this command.<\/p>\n<h4>Command<\/h4>\n<p>The command to run. This can be quite powerful &#8211; check out the presets for inspiration.<\/p>\n<p>Available variables:<\/p>\n<ul>\n<li>%filepath &#8211; Output script file path<\/li>\n<li>%dbpath &#8211; Output database folder path<\/li>\n<li>%rootdir &#8211; Output repository \/ root folder path<\/li>\n<li>%message &#8211; If present, prompts the user for a message<\/li>\n<\/ul>\n<h4>Auto-close command window<\/h4>\n<p>Whether or not to close the command once it&#8217;s finished running. If the command&#8217;s purpose is to provide information to the user, leave this unchecked.<\/p>\n<h4>Start commit from output<\/h4>\n<p>Kicks off the VersionSQL commit process using a list of files returned from your custom command. Useful for granular commits with custom logic, such as committing only locked files.<\/p>\n<p>Script output should be one path per line, relative to database or repository root. If the path is not specific enough (e.g. just the object name), similarly-named objects may be pulled into the commit. Does not match objects that have been deleted from the database.<\/p>\n<h2>Search<\/h2>\n<p>Provides a text search for locating setting controls.<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":911,"menu_order":3,"comment_status":"closed","ping_status":"closed","template":"","meta":{"inline_featured_image":false,"footnotes":""},"doc_tag":[],"class_list":["post-921","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/www.versionsql.com\/help\/wp-json\/wp\/v2\/docs\/921","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.versionsql.com\/help\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.versionsql.com\/help\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.versionsql.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.versionsql.com\/help\/wp-json\/wp\/v2\/comments?post=921"}],"version-history":[{"count":27,"href":"https:\/\/www.versionsql.com\/help\/wp-json\/wp\/v2\/docs\/921\/revisions"}],"predecessor-version":[{"id":1769,"href":"https:\/\/www.versionsql.com\/help\/wp-json\/wp\/v2\/docs\/921\/revisions\/1769"}],"up":[{"embeddable":true,"href":"https:\/\/www.versionsql.com\/help\/wp-json\/wp\/v2\/docs\/911"}],"prev":[{"title":"Run Command After Save","link":"https:\/\/www.versionsql.com\/help\/documentation\/connection-settings\/run-command-after-save\/","href":"https:\/\/www.versionsql.com\/help\/wp-json\/wp\/v2\/docs\/923"}],"wp:attachment":[{"href":"https:\/\/www.versionsql.com\/help\/wp-json\/wp\/v2\/media?parent=921"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.versionsql.com\/help\/wp-json\/wp\/v2\/doc_tag?post=921"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}