Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

MFSQL Connector 5.13.37.81 documentation

Toggle table of contents sidebar

MFSQL Connector 5.13.37.81 documentation

FAQ:

Frequently asked questions
Toggle navigation of Frequently asked questions
- Advanced FAQ (Deep Dive Cross-Refs)

MFSQL Connector Guide:

Introduction to MFSQL
Toggle navigation of Introduction to MFSQL
- Introducing MFSQL Connector
- System Requirements
- MFSQL Connector modules
- Functional Overview
  Toggle navigation of Functional Overview
- Practical tips and Use Cases
- Licensing
  Toggle navigation of Licensing
  - MFSQL Connector License Agreement
- Installing MFSQL Connector
Getting Started
Toggle navigation of Getting Started
- Planning and prerequisites
- Install
  Toggle navigation of Install
  - Common installation notes
  - On‑premises: single server
  - On‑premises: split servers
  - Install the Web API
  - Cloud
    Toggle navigation of Cloud
  - High availability (SQL cluster)
  - Manual installation path
- Post-install
  Toggle navigation of Post-install
  - License management (Post-Install)
  - Connection and Web API
  - Configure the context menu
  - Enable VAF logging
  - Database Mail
  - Using Agent for automated updates
    Toggle navigation of Using Agent for automated updates
  - Setup powershell utilities
    Toggle navigation of Setup powershell utilities
    - Setup database script
    - Validate table procedure
- Validate and smoke tests
- Upgrades and hotfixes
  Toggle navigation of Upgrades and hotfixes
- Upgrade to Release 5
- Next Steps after installation
- Common installation errors and resolutions
  Toggle navigation of Common installation errors and resolutions
  - Install package with logging
- Example scripts to get started
  Toggle navigation of Example scripts to get started
- Installation Overview (legacy)
- On Premise Installation (legacy)
- M-Files Cloud and other hosted installations (legacy)
  Toggle navigation of M-Files Cloud and other hosted installations (legacy)
  - Installing the Web API
- High Availability SQL Servers installation (legacy)
- Configuration and setup (legacy)
  Toggle navigation of Configuration and setup (legacy)
  - Update settings
  - Installing the Context Menu
  - Enabling and configuring the VAF logging
  - Database Mail
  - Using Agent for automated updates
    Toggle navigation of Using Agent for automated updates
  - Setup powershell utilities
    Toggle navigation of Setup powershell utilities
    - Setup database script
    - Validate table procedure
- Manual installation using scripts (legacy)
  Toggle navigation of Manual installation using scripts (legacy)
  - Content Package installation (legacy)
MFSQL Data Exchange and Reporting Connector
Toggle navigation of MFSQL Data Exchange and Reporting Connector
- Working with Metadata
  Toggle navigation of Working with Metadata
- Working with Class Tables
  Toggle navigation of Working with Class Tables
- Working with Class Tables (Deep Dive)
  Toggle navigation of Working with Class Tables (Deep Dive)
- Using the Context Menu
  Toggle navigation of Using the Context Menu
- Reporting
  Toggle navigation of Reporting
MFSQL Integration Connector
Toggle navigation of MFSQL Integration Connector
- Exploring metadata
- Integration Deep Dive Topics
  Toggle navigation of Integration Deep Dive Topics
- Building custom applications and integrations
  Toggle navigation of Building custom applications and integrations
- Property and column usage
- Metadata Search
- Update / Create Valuelist Items from SQL
- User Messages
- Lookup views
- Send Bulk Email
- Working with files
- Working with aliases
- Correcting synchronization errors
- Change of vault
- Daily and monthly routines for agents
- Tips and tricks on using the connector
- Getting deleted objects
- Using and managing logs
  Toggle navigation of Using and managing logs
- Working with Object Version
- Contextmenu queue (Removed)
- MFSQL Connector addons and utilities
- Users in Usergroups
Release 5
Toggle navigation of Release 5
- Future enhancements
The Connector Framework
Toggle navigation of The Connector Framework
- Architecture
- Connector Content
  Toggle navigation of Connector Content
  - Assemblies
  - Metadata Structure Tables
    Toggle navigation of Metadata Structure Tables
  - Class tables
    Toggle navigation of Class tables
  - Utility Tables
  - Logging Tables
  - Procedures and Functions
    Toggle navigation of Procedures and Functions
  - M-Files Installation
  - Context Menu
  - Supporting Applications
    Toggle navigation of Supporting Applications
    - Custom tables, views, procedures and functions
  - MFSQL Connector Operations
- Connector Database
  Toggle navigation of Connector Database
  - Using CLR
  - M‑Files API version and CLR assembly updates
- Enabling the database
- Licensing
- Security
  Toggle navigation of Security
  - Schemas
Version Control
Toggle navigation of Version Control
- Version Control — Release 4
- Version Control — Release 5

Blog:

List of blogs
Toggle navigation of List of blogs

SQL Components:

Procedures
Toggle navigation of Procedures
- spMFAddCommentForObjects
- Signature
- Purpose
- Additional Info
- Warnings
- Examples
- Changelog
- spMFAliasesUpsert
- Signature
- Purpose
- Additional Info
- Examples
- Changelog
- spMFChangeClass
- Signature
- Purpose
- Additional Info
- Examples
- Changelog
- spMFCheckAndUpdateAssemblyVersion
- Signature
- Purpose
- Additional Info
- Warnings
- Examples
- Changelog
- spMFCheckLicenseStatus
- spMFClassTableColumns
- Signature
- Purpose
- Additional Info
- Examples
- Changelog
- spMFClassTableStats
- Signature
- Purpose
- Additional Info
- Report by Email
- Warnings
- Corrective Action
- Usage
- Additional Examples
- Changelog
- spMFConnectionTest
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- spMFContextMenuActionItem
- Signature
- Purpose
- Additional Info
- Examples
- Changelog
- spMFContextMenuHeadingItem
- Signature
- Purpose
- Prerequisites
- Examples
- Changelog
- spMFConvertTableToHtml
- Signature
- Parameters
- Purpose
- Additional info
- Examples
- Changelog
- spMFCreateAllLookups
- Signature
- Purpose
- Changelog
- spMFCreateAllMFTables
- Signature
- Purpose
- Examples
- Changelog
- spMFCreatePublicSharedLink
- Signature
- Purpose
- Additional Info
- Warnings
- Examples
- Changelog
- spMFCreateTable
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Prerequisites
- Warnings
- Examples
- Changelog
- spMFCreateValueListLookupView
- Signature
- Purpose
- Additional Info
- Warnings
- Examples
- Changelog
- spMFCreateWorkflowStateLookupView
- Signature
- Purpose
- Additional Info
- Examples
- Changelog
- spMFDeleteAdhocProperty
- Signature
- Purpose
- Additional Info
- Prerequisites
- Examples
- Changelog
- spMFDeleteHistory
- Signature
- Purpose
- Examples
- Changelog
- spMFDeleteObject
- Signature
- Parameters
- Purpose
- Additional Information
- Warnings
- Examples
- Changelog
- spMFDeleteObjectList
- Signature
- Returns
- Parameters
- Purpose
- Prerequisites
- Additional info
- Warning
- Examples
- Changelog
- spMFDeleteObjectVersionList
- Signature
- Returns
- Parameters
- Purpose
- Prerequisites
- Warning
- Examples
- Changelog
- spMFDeploymentDetails
- Signature
- Purpose
- Examples
- Changelog
- spMFDropAllClassTables
- Signature
- Purpose
- Examples
- Changelog
- spMFDropAndUpdateMetadata
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Warnings
- Examples
- Changelog
- spMFExportFiles
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Examples
- Changelog
- spMFExportFilesMultiClasses
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Prerequisites
- Folder setting examples
- Examples
- Changelog
- spMFGetDataExport
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFGetDeletedObjects
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFGetHistory
- Purpose
- Additional Info
- Prerequisites
- Warnings
- Examples
- Changelog
- spMFGetLicense
- Purpose
- Examples
- Changelog
- spMFGetMFilesAssemblyVersion
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Warnings
- Examples
- Changelog
- spMFGetMfilesLog
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Examples
- Changelog
- spMFGetObjectvers
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- spMFGetProcedurePerformance
- Signature
- Purpose
- Additional Info
- Examples
- Changelog
- spMFImportBlobFilesToMFiles
- Signature
- Purpose
- Additional Info
- Prerequisites
- Examples
- Changelog
- spMFInsertClass
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFInsertClassProperty
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFInsertLoginAccount
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFInsertObjectType
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Prerequisites
- Warnings
- Examples
- Changelog
- spMFInsertProperty
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFInsertUserAccount
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFInsertUserMessage
- Signature
- Returns
- Parameters
- Purpose
- Addition Info
- Examples
- Changelog
- spMFInsertValueList
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Prerequisites
- Warnings
- Examples
- Changelog
- spMFInsertValueListItems
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Prerequisites
- Warnings
- Examples
- Changelog
- spMFInsertWorkflow
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Prerequisites
- Warnings
- Examples
- Changelog
- spMFInsertWorkflowState
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFLogError_EMail
- Signature
- Purpose
- Warnings
- Examples
- Changelog
- spMFLogProcessSummaryForClassTable
- Signature
- Purpose
- Additional Info
- Prerequisites
- Warnings
- Examples
- Changelog
- spMFObjectTypeUpdateClassIndex
- Signature
- Purpose
- Prerequisites
- Examples
- Changelog
- spMFProcessBatchDetail_Insert
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Examples
- Changelog
- spMFProcessBatch_Upsert
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- spMFProcessBatch_Mail
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Prerequisites
- Examples
- Changelog
- spMFRemoveAdditionalProperties
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Examples
- Changelog
- spMFResultMessageForUI
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Prerequisites
- Warnings
- Examples
- Changelog
- spMFSearchForObject
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Examples
- Changelog
- spMFSearchForObjectbyPropertyValues
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Examples
- Changelog
- spMFSendHTMLBodyEmail
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Prerequisites
- Examples
- Changelog
- SpmfSetAdditionalProperty
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Prerequisites
- Warnings
- Examples
- Changelog
- spMFSetContextMenuQueue
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Examples
- Changelog
- spMFSetUniqueIndexes
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- spMFSetup_Reporting
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Warnings
- Examples
- Changelog
- spMFSynchronizeClasses
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFSynchronizeFilesToMFiles
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- spMFSynchronizeLoginAccount
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFSynchronizeLookupColumnChange
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Examples
- Changelog
- spMFSynchronizeMetadata
- Signature
- Returns
- Parameters
- Purpose
- Prerequisites
- Warnings
- Examples
- Changelog
- spMFSynchronizeObjectType
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFSynchronizeProperties
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- spMFSynchronizeSpecificMetadata
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Examples
- Changelog
- spMFSynchronizeUserAccount
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFSynchronizeValueList
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- spMFSynchronizeValueListItems
- Purpose
- spMFSynchronizeValueListItemsToMfiles
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Prerequisites
- Examples
- Changelog
- spMFSynchronizeWorkFlowStateColumnChange
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- spMFSynchronizeWorkflow
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFSynchronizeWorkflowsStates
- Signature
- Returns
- Parameters
- Purpose
- Changelog
- spMFTableAudit
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Examples
- Changelog
- spMFUnDeleteObject
- Signature
- Returns
- Parameters
- Purpose
- Warnings
- Examples
- Changelog
- spMFUpdateAllncludedInAppTables
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Warning
- Examples
- Changelog
- spMFUpdateAssemblies
- Purpose
- Additional Info
- Examples
- Changelog
- spMFUpdateAssemblyLog
- Purpose
- Additional Info
- Changelog
- spMFUpdateContextMenuQueue
- Purpose
- Additional Info
- Examples
- Changelog
- spMFUpdateExplorerFileToMFiles
- Purpose
- Additional Info
- Warnings
- Examples
- Changelog
- spMFUpdateHistoryShow
- Purpose
- Additional Info
- Warning
- Examples
- Changelog
- spMFUpdateItemByItem
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Examples
- Changelog
- spMFUpdateMFilesToMFSQL
- Purpose
- Additional Info
- Warnings
- Examples
- Changelog
- spMFUpdateObjectChangeHistory
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Prerequisites
- Examples
- Changelog
- spMFUpdateSynchronizeError
- Purpose
- Examples
- Changelog
- spMFUpdateTable
- Purpose
- Prerequisites
- Warnings
- Examples
- Changelog
- spMFUpdateTableInternal
- Signature
- Returns
- Parameters
- Purpose
- Additional Info
- Changelog
- spMFUpdateTableWithLastModifiedDate
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- spMFUpdateTable_ObjIDs_GetGroupedList
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- spMFUpdateTable_ObjIDs_Grouped
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- spMFUpdateTableinBatches
- Purpose
- Additional Info
- Prerequisites
- Warning
- Examples
- Changelog
- spMFUsersByUserGroup
- Purpose
- Examples
- Changelog
- spMFValidateEmailProfile
- Purpose
- Additional info
- Examples
- Changelog
- spMFVaultConnectionTest
- Purpose
- Additional Info
- Examples
- Changelog
- spMFsettingsForDBUpdate
- Signature
- Purpose
- Additional Info
- Prerequisites
- Warnings
- Examples
- Changelog
- spMFsettingsForVaultUpdate
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
Tables
Toggle navigation of Tables
- MFAuditHistory
- Columns
- Indexes
- Additional Info
- Changelog
- MFAuthenticationType
- Columns
- Used By
- Changelog
- MFObjectChangeHistoryUpdateControl
- Columns
- Additional info
- Used By
- Changelog
- MFClass
- Columns
- Additional Info
- Indexes
- Foreign Keys
- Examples
- Changelog
- MFClassProperty
- Columns
- Additional Info
- Indexes
- Changelog
- MFContextMenu
- Columns
- Used By
- Changelog
- MFContextMenuQueue
- Columns
- Additional Info
- Indexes
- Foreign Keys
- Uses
- Used By
- Examples
- Changelog
- MFDataType
- Description
- Columns
- Indexes
- Used By
- Changelog
- MFDeploymentDetail
- Columns
- Additional Info
- Used By
- Changelog
- MFEmailTemplate
- Description
- Columns
- Additional Info
- Placeholders
- Example Insert statement
- Changelog
- MFEmailLog
- Description
- Columns
- Additional Info
- Used By
- Changelog
- MFEventLog_OpenXML
- Columns
- Additional Info
- Used By
- Changelog
- MFExportFileHistory
- Columns
- Used By
- Changelog
- MFFileExportControl
- Columns
- Additional Info
- Used By
- Changelog
- MFFileImport
- Columns
- Additional Info
- Used By
- Changelog
- MFLog
- Columns
- Indexes
- Usage
- Changelog
- MFLoginAccount
- Columns
- Additional Info
- Relation
- Changelog
- MFObjectChangeHistory
- Columns
- Additional Info
- Used By
- Changelog
- MFObjectType
- Columns
- Indexes
- Changelog
- MFProcessBatch
- Columns
- Additional Info
- Used By
- Changelog
- MFProcessBatchDetail
- Columns
- Additional Info
- Indexes
- Used By
- Changelog
- MFProperty
- Columns
- Additional Info
- Indexes
- Foreign Keys
- Changelog
- tbMFProtocolType
- MFPublicLink
- Columns
- Used By
- Changelog
- MFSearchLog
- Columns
- Used By
- Changelog
- MFSettings
- Columns
- Changelog
- MFUpdateHistory
- Columns
- Additional Info
- Indexes
- Used By
- Changelog
- MFUserAccount
- Columns
- Indexes
- Additional Info
- Relation
- Changelog
- MFValueList
- Columns
- Additional Info
- Indexes
- USAGE
- Changelog
- MFValueListItems
- Columns
- Additional Info
- Indexes
- Foreign Keys
- Examples
- Change control
- tbMFVaultSettings
- MFWorkflow
- Columns
- Indexes
- Changelog
- MFWorkflowState
- Columns
- Additional Info
- Indexes
- Foreign Keys
- Changelog
- MFilesEvents
- Columns
- Indexes
- Additional Info
- Changelog
Functions
Toggle navigation of Functions
- fnMFCapitalizeFirstLetter
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- fnMFExcelObjectHyperlink
- Signature
- Returns
- Parameters
- Purpose
- Notes
- Examples
- Related
- Changelog
- FnMFFloatToString
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- FnMFGetCulture
- Signature
- Returns
- Purpose
- Examples
- Changelog
- fnMFLastConnectorVersion
- Signature
- Returns
- Purpose
- Examples
- Changelog
- fnMFMultiLookupUpsert
- Purpose
- Examples
- Changelog
- fnMFObjectHyperlink
- Signature
- Returns
- Parameters
- Purpose
- Limitations
- Examples
- Related
- Changelog
- fnMFParseDelimitedString
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- fnMFRemoveIllegalXMLCharacters
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- fnMFReplaceSpecialCharacter
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- fnMFSplit
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- fnMFSplitPairedStrings
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- fnMFSplitString
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- fnMFTextToDate
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- fnMFVariableTableName
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
- fnMFVaultSettings
- Signature
- Returns
- Parameters
- Purpose
- Examples
- Changelog
Views
Toggle navigation of Views
- MFvwAuditSummary
- Purpose
- Examples
- Changelog
- MFvwClassTableColumns
- Purpose
- Examples
- Changelog
- MFvwLogTableStats
- Purpose
- Examples
- Changelog
- MFvwMetadataStructure
- Purpose
- Examples
- Changelog
- MFvwObjectChangeHistory
- Purpose
- Examples
- Changelog
- MFvwObjectTypeSummary
- Purpose
- Additional Info
- Examples
- Changelog
- MFvwTableID
- Purpose
- Examples
- Changelog
Triggers
Toggle navigation of Triggers

Toggle table of contents sidebar

Tables¶

spMFsettingsForVaultUpdate

Copyright © 2023, Laminin Solutions Ltd

Made with Sphinx and @pradyunsg's Furo