CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるMonday へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してMonday に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、Monday への接続を標準化し、構成することができます。
このページでは、CData Cloud でのMonday への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのMonday への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してMonday からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Monday に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
Monday AuditLog API は、API トークンによる認証のみをサポートしています。
監査ログAPI トークンを生成するには:
API トークンを取得した後、以下の接続プロパティを設定します。
これで、Monday AuditLog API に接続する準備が整いました。
Monday GraphQL API は、API トークンまたはOAuth 標準による認証をサポートしています。
API トークンでCloud に接続するには、AuthScheme をToken に設定し、次の手順でAPIToken を取得します。
以下のサブセクションでは、3つの標準的な認証フローでのMonday への認証について詳しく説明します。
カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。
Monday で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。
アクセストークンの期限が切れたときは、Cloud は自動でアクセストークンをリフレッシュします。
OAuth アクセストークンの自動リフレッシュ:
Cloud がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Cloud は、Monday API のエンティティをビューおよびストアドプロシージャにモデル化します。これらは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。
Information スキーマで利用可能なエンティティについては、Information データモデル を参照してください。
AuditLog スキーマで利用可能なエンティティについては、AuditLog データモデル を参照してください。
Workspace タイプのスキーマで利用可能なエンティティについては、Workspace データモデル を参照してください。
This section shows the available API objects and provides more information on executing SQL to Monday APIs.
テーブル are tables that can be modified.
ビュー are tables that cannot be modified. Typically, model data that is read-only and cannot be updated are shown as views.
ストアドプロシージャ are function-like interfaces to the data source.
Cloud はMonday のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
Boards | Get a collection of boards. |
BoardTeams | Get a board's team subscribers. |
BoardUsers | Get a board's subscribers. |
DocBlocks | Get a document's content blocks. |
Docs | Get a collection of docs. |
Folders | Get a collection of folders. Note that this won't return folders from closed workspaces to which you are not subscribed. |
Groups | Get a board's visible groups. |
Tags | Get a collection of tags. |
TeamUsers | Get a team's users. |
Updates | Get a collection of updates. |
Webhooks | Get a collection of webhooks. |
Workspaces | Get a collection of workspaces. |
WorkspaceTeams | Get the teams subscribed to the workspace. |
WorkspaceUsers | Get the users subscribed to the workspace. |
Get a collection of boards.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM Boards WHERE Id = '2182296646'
SELECT * FROM Boards WHERE Id IN ('2307103055', '2182296646', '2181960030')
SELECT * FROM Boards WHERE Id IN ('2307103055', '2182296646', '2181960030') AND BoardKind = 'public'
SELECT * FROM Boards WHERE BoardKind = 'public'
INSERT statements are mapped to the 'create_board' GraphQL mutation.
The following inputs can be used in INSERT statements:
Name, Description, BoardKind, BoardFolderId, WorkspaceId, TemplateId, BoardOwnerIds, BoardOwnerTeamIds, BoardSubscriberIds, BoardSubscriberTeamIds, Empty
INSERT INTO Boards (WorkspaceId,BoardKind,Name,Description,BoardFolderId,BoardOwnerIds,BoardSubscriberTeamIds,Empty) VALUES ('3820334','public','NewBoard','A newly created board.','12689416','51688059,51085546','960990',true)
UPDATE statements are mapped to the 'update_board' and 'archive_board' GraphQL mutations.
The following inputs can be used in UPDATE statements (note that due to API limitations only one column's value can be updated per statement):
Id, Name, Description, Communication, State, BoardAttributes
UPDATE Boards SET Name='AnotherName' WHERE Id='5549166043'
UPDATE Boards SET State='archived' WHERE Id='5549166043'
DELETE statements are mapped to the 'delete_board' GraphQL mutation.
You can delete entries by specifying the Id.
DELETE FROM Boards WHERE Id='5549166043'
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The unique identifier of the board. | |
CreatorId | String | False |
Users.Id |
The user's unique identifier. |
Name | String | False |
The board's name. | |
ItemTerminology | String | False |
The Board's item nickname, one of a predefined set of values, or a custom user value. | |
ItemsCount | Int | False |
The number of items on the board. | |
TopGroupId | String | False |
Groups.Id |
The group's unique identifier. |
Description | String | False |
The board's description. | |
UpdatedAt | Datetime | False |
The last time the board was updated at. | |
Type | String | False |
The board object type. | |
BoardKind | String | False |
The board's kind (public / private / share). | |
BoardFolderId | String | False |
Folders.Id |
The board's folder unique identifier. |
Communication | String | False |
Get the board communication value - typically meeting ID. | |
Permissions | String | False |
The board's permissions. | |
TagsIds | String | False |
Tags.Id |
A comma separated list of the tags' unique identifiers. |
State | String | False |
The board's state (all / active / archived / deleted). | |
WorkspaceId | String | False |
Workspaces.Id |
The board's workspace unique identifier (null for main workspace). |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
TemplateId | String |
Optional board template id. |
BoardOwnerIds | String |
Optional, comma-seperated list of board owner user ids. |
BoardOwnerTeamIds | String |
Optional, comma-seperated list of board owner team ids. |
BoardSubscriberIds | String |
Optional, comma-seperated list of board subscriber ids. |
BoardSubscriberTeamIds | String |
Optional, comma-seperated list of subscriber team ids. |
Empty | Bool |
Optional flag to create an empty board (without any default items). |
Get a board's team subscribers.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM BoardTeams WHERE BoardId='5557271485'
INSERT statements are mapped to the 'add_teams_to_board' GraphQL mutation.
The following inputs can be used in INSERT statements:
Id, BoardId, Kind
INSERT INTO BoardTeams (Id,BoardId,Kind) VALUES ('51688059','5546871560','subscriber')
DELETE statements are mapped to the 'delete_teams_from_board' GraphQL mutation.
You can delete entries by specifying the Id and BoardId.
DELETE FROM BoardTeams WHERE Id='51688059' AND BoardId='5546871560'
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
Teams.Id |
The board team's unique identifier. |
BoardId [KEY] | String | False |
Boards.Id |
The unique identifier of the board. |
Kind | String | False |
The team's role: subscriber or owner. All owners are by default also subscribers. This column can be used to filter non-owners. |
Get a board's subscribers.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM BoardUsers WHERE BoardId='5525287714'
SELECT * FROM BoardUsers WHERE Kind='owner'
INSERT statements are mapped to the 'add_users_to_board' GraphQL mutation.
The following inputs can be used in INSERT statements:
Id, BoardId, Kind
INSERT INTO BoardUsers (Id,BoardId,Kind) VALUES ('51688059','5546871560','subscriber')
DELETE statements are mapped to the 'delete_subscribers_from_board' GraphQL mutation.
You can delete entries by specifying the Id and BoardId.
DELETE FROM BoardUsers WHERE Id='51688059' AND BoardId='5546871560'
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
Users.Id |
The board owner's unique identifier. |
BoardId [KEY] | String | False |
Boards.Id |
The unique identifier of the board. |
Kind | String | False |
The user's role: subscriber or owner. All owners are by default also subscribers. This column can be used to filter non-owners. |
Get a document's content blocks.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM DocBlocks WHERE DocId = '9014425'
SELECT * FROM DocBlocks WHERE DocId IN ('9014425','9014490')
INSERT statements are mapped to the 'create_doc_block' GraphQL mutation.
The following inputs can be used in INSERT statements:
ParentBlockId, DocId, Content, Type, AfterBlockId
INSERT INTO DocBlocks (DocId,Type,Content,AfterBlockId) VALUES ('9180448','code','{"alignment":"left","direction":"ltr","deltaFormat":[{"insert":"Test"}]}','53ab947f-226f-49f5-8d43-1021f9f36431')
UPDATE statements are mapped to the 'update_doc_block' GraphQL mutation.
The following inputs can be used in UPDATE statements:
Id, Content
UPDATE DocBlocks SET Content='{"alignment":"left","direction":"ltr","deltaFormat":[{"insert":"NewValue"}]}' WHERE Id = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
DELETE statements are mapped to the 'delete_doc_block' GraphQL mutation.
You can delete entries by specifying the Id.
DELETE FROM DocBlocks WHERE Id = '9b24043b-6ea9-46b0-9f0a-1ec226f12d21'
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The block's unique identifier. | |
ParentBlockId | String | False |
The block's parent block unique identifier. | |
DocId | String | False |
Docs.Id |
The block's document unique identifier. |
CreatedById | String | False |
Users.Id |
The user's unique identifier. |
Position | Double | False |
The block's position on the document. | |
Content | String | False |
The block's content. | |
Type | String | False |
The block content type. | |
CreatedAt | Date | False |
The block's creation date. | |
UpdatedAt | Date | False |
The block's last updated date. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
AfterBlockId | String |
After which block to insert this one. If not provided, will be inserted first in the document. |
Get a collection of docs.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM Docs WHERE Id = '9014425'
SELECT * FROM Docs WHERE Id IN ('9014425','9014490')
SELECT * FROM Docs WHERE ObjectId = '5499548740'
SELECT * FROM Docs WHERE ObjectId IN ('5499548740','5499563743')
SELECT * FROM Docs WHERE WorkspaceId = '3578971'
INSERT statements are mapped to the 'create_doc' GraphQL mutation.
The following inputs can be used in INSERT statements:
WorkspaceId, DocKind, Name
INSERT INTO Docs (WorkspaceId,DocKind,Name) VALUES ('3820334','public','CreatedDoc')
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The document's unique identifier. | |
DocFolderId | String | False |
Folders.Id |
The document's folder unique identifier (null for first level). |
ObjectId | String | False |
The associated board or object's unique identifier. | |
WorkspaceId | String | False |
Workspaces.Id |
The document's workspace unique identifier (null for main workspace). |
CreatedById | String | False |
Users.Id |
The user's unique identifier. |
DocKind | String | False |
The document's kind (public / private / share). | |
Name | String | False |
The document's name. | |
RelativeUrl | String | False |
The document's relative url. | |
Settings | String | False |
The document's settings. | |
Url | String | False |
The document's direct url. | |
CreatedAt | Date | False |
The document's creation date. |
Get a collection of folders. Note that this won't return folders from closed workspaces to which you are not subscribed.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM Folders WHERE Id = '12622355'
SELECT * FROM Folders WHERE WorkspaceId = '3578971'
INSERT statements are mapped to the 'create_folder' GraphQL mutation.
The following inputs can be used in INSERT statements:
ParentId, WorkspaceId, Color, Name
INSERT INTO Folders (WorkspaceId,Name,Color) VALUES ('3578971','TestFolder','BRIGHT_BLUE')
UPDATE statements are mapped to the 'update_folder' GraphQL mutation.
The following inputs can be used in UPDATE statements:
Id, ParentId, Color, Name
UPDATE Folders SET Color='SUNSET',Name='UpdatedName' WHERE Id='12678064'
DELETE statements are mapped to the 'delete_folder' GraphQL mutation.
You can delete entries by specifying the Id.
DELETE FROM Folders WHERE Id='12678064'
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The folder's unique identifier. | |
OwnerId | String | False |
Users.Id |
The folder's user owner unique identifier. |
ParentId | String | False |
The unique identifiers of the folder's parent folder. | |
SubFolderIds | String | False |
The unique identifiers of the sub-folders inside the folder. | |
WorkspaceId | String | False |
Workspaces.Id |
The workspace's unique identifier. |
Color | String | False |
The folder's color. | |
Name | String | False |
The folder's name. | |
CreatedAt | Datetime | False |
The folder's creation date. |
Get a board's visible groups.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM Groups WHERE Id = 'topics'
SELECT * FROM Groups WHERE Id IN ('topics', 'group_title')
SELECT * FROM Groups WHERE BoardId IN ('2182296646', '21822966')
SELECT * FROM Groups WHERE BoardId = '2182296646' AND Id = 'topics'
INSERT statements are mapped to the 'create_group' GraphQL mutation.
The following inputs can be used in INSERT statements:
BoardId, Title, RelativeTo, PositionRelativeMethod
INSERT INTO Groups (BoardId,Title,RelativeTo,PositionRelativeMethod) VALUES ('5525287714','NewGroup','testgroup','after_at')
UPDATE statements are mapped to the 'update_group' and 'archive_group' GraphQL mutations.
The following inputs can be used in UPDATE statements (note that due to API limitations only one column's value can be updated per statement):
Id, BoardId, Archived, Color, Title, RelativePositionAfter, RelativePositionBefore
UPDATE Groups SET Color='lime-green' WHERE BoardId='5525287714' AND Id='newgroup'
UPDATE Groups SET Archived='true' WHERE BoardId='5525287714' AND Id='newgroup'
DELETE statements are mapped to the 'delete_group' GraphQL mutation.
You can delete entries by specifying the Id and BoardId.
DELETE FROM Groups WHERE BoardId='5525287714' AND Id='testgroup'
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The group's unique identifier. | |
BoardId [KEY] | String | False |
Boards.Id |
The unique identifier of the board. |
Archived | Bool | False |
Whether or not the group is archived. | |
Color | String | False |
The group's color. | |
Deleted | Bool | False |
Whether or not the group is deleted. | |
Position | String | False |
The group's position in the board. | |
Title | String | False |
The group's title. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
RelativeTo | String |
The group to set the position next to. |
PositionRelativeMethod | String |
The position relative method to another group (before_at / after_at). |
RelativePositionAfter | String |
The group's relative position after another group in the board. |
RelativePositionBefore | String |
The group's relative position before another group in the board. |
Get a collection of tags.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM Tags WHERE IsPrivate = true
SELECT * FROM Tags WHERE IsPrivate = false
SELECT * FROM Tags WHERE Id = '13327214'
SELECT * FROM Tags WHERE Id IN ('13327214', '13327217')
INSERT statements are mapped to the 'create_or_get_tag' GraphQL mutation.
The following inputs can be used in INSERT statements:
Name, BoardId
INSERT INTO Tags (Name) VALUES ('TestTagName')
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The tag's unique identifier. | |
Color | String | False |
The tag's color. | |
Name | String | False |
The tag's name. | |
IsPrivate | Bool | False |
Whether or not the tag is private. | |
BoardId | String | False |
A private board id to filter by or create a tag at (not needed for public boards). |
Get a collection of updates.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM Updates WHERE Id = '173981152'
SELECT * FROM Updates WHERE ItemId = '1388002886'
SELECT * FROM Updates WHERE BoardId = '1388002765'
INSERT statements are mapped to the 'create_update' GraphQL mutation.
The following inputs can be used in INSERT statements:
Body, ItemId, ParentId
INSERT INTO Updates (ItemId,Body,ParentId) VALUES ('5525287847','This is a new reply.','2553498004')
DELETE statements are mapped to the 'delete_update' GraphQL mutation.
You can delete entries by specifying the Id.
DELETE FROM Updates WHERE Id='2553512994'
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The update's unique identifier. | |
Body | String | False |
The update's html formatted body. | |
CreatedAt | Datetime | False |
The update's creation date. | |
CreatorId | String | False |
Users.Id |
The unique identifier of the update creator. |
ItemId | String | False |
The update's item ID. | |
TextBody | String | False |
The update's text body. | |
UpdatedAt | Datetime | False |
The update's last edit date. | |
AssetsIds | String | False |
Assets.Id |
A comma separated list of the update's assets/files unique identifiers. |
Replies | String | False |
The update's replies. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ParentId | String |
The parent update's unique identifier. This can be used to create a reply to an update. |
Get a collection of webhooks.
The Cloud uses the Monday API to process WHERE clause conditions built with the following column and operator. The Cloud processes other filters client-side within the Cloud.
SELECT * FROM Webhooks WHERE BoardId='5574930939'
INSERT statements are mapped to the 'create_webhook' GraphQL mutation.
The following inputs can be used in INSERT statements:
BoardId, Config, Event, Url
INSERT INTO Webhooks (BoardId,Config,Event,Url) VALUES ('5574930939','{\"columnId\":\"status\", \"columnValue\":{\"$any$\":true}}','change_status_column_value','https://test.com/')
DELETE statements are mapped to the 'delete_webhook' GraphQL mutation.
You can delete entries by specifying the Id.
DELETE FROM Webhooks WHERE Id='242031214'
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The webhooks's unique identifier. | |
BoardId | String | False |
Board unique identifier. | |
Config | String | False |
The webhooks's config. | |
Event | String | False |
The event webhook will listen to. | |
AppWebhooksOnly | Bool | False |
Filters webhooks that were created by the app initiating the request. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Url | String |
The webhook URL. |
Get a collection of workspaces.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM Workspaces WHERE Id='3578971'
SELECT * FROM Workspaces WHERE Kind='open'
SELECT * FROM Workspaces WHERE State='active'
INSERT statements are mapped to the 'create_workspace' GraphQL mutation.
The following inputs can be used in INSERT statements:
Description, Kind, Name
INSERT INTO Workspaces (Name,Kind,Description) VALUES ('New Workspace','open','This is my new workspace.')
UPDATE statements are mapped to the 'update_workspace' GraphQL mutation.
The following inputs can be used in INSERT statements:
Id, Description, Name, Kind
UPDATE Workspaces Set Description='testDescription', Name='testName', Kind='open' WHERE Id='3819431'
DELETE statements are mapped to the 'delete_workspace' GraphQL mutation.
You can delete entries by specifying the Id.
DELETE FROM Workspaces WHERE Id='3819431'
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The workspace's unique identifier. | |
Description | String | False |
The workspace's description. | |
Kind | String | False |
The workspace's kind (open / closed). | |
Name | String | False |
The workspace's name. | |
State | String | False |
The workspace's state (all / active / archived / deleted). | |
CreatedAt | Datetime | False |
The workspace's creation date. | |
AccountProductId | String | False |
The account product id. | |
AccountProductKind | String | False |
The account product kind (core / marketing / crm / software / projectManagement / project_management / forms / whiteboard). | |
SettingsIconColor | String | False |
The icon color in hex value. Used as a background for the image. | |
SettingsIconImage | String | False |
The public image URL, which is temporary in the case of a file that was uploaded by the user, so you'll need to pull a new version at least once an hour. In case it is null, you can use the first letter of the workspace name. |
Get the teams subscribed to the workspace.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM WorkspaceTeams WHERE Kind='owner'
SELECT * FROM WorkspaceTeams WorkspaceId='3820334'
INSERT statements are mapped to the 'add_teams_to_workspace' GraphQL mutation.
The following inputs can be used in INSERT statements:
Id, WorkspaceId, Kind
INSERT INTO WorkspaceTeams (Id,WorkspaceId,Kind) VALUES ('961021','3820334','subscriber')
INSERT INTO WorkspaceTeams (Id,WorkspaceId,Kind) VALUES ('961021','3820334','owner')
DELETE statements are mapped to the 'delete_teams_from_workspace' GraphQL mutation.
You can delete entries by specifying the Id and WorkspaceId.
DELETE FROM WorkspaceTeams WHERE Id='961021' AND WorkspaceId='3820334'
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The team's unique identifier. | |
WorkspaceId [KEY] | String | False |
The workspace's unique identifier. | |
Kind | String | False |
The team's role: subscriber or owner. All owners are by default also subscribers. This column can be used to filter non-owners. |
Get the users subscribed to the workspace.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM WorkspaceUsers WHERE WorkspaceId='3578971'
SELECT * FROM WorkspaceUsers WHERE Kind='owner'
INSERT statements are mapped to the 'add_users_to_workspace' GraphQL mutation.
The following inputs can be used in INSERT statements:
Id, WorkspaceId, Kind
INSERT INTO WorkspaceUsers (Id,WorkspaceId,Kind) VALUES ('51688059','3820334','subscriber')
DELETE statements are mapped to the 'delete_users_from_workspace' GraphQL mutation.
You can delete entries by specifying the Id and WorkspaceId.
DELETE FROM WorkspaceUsers WHERE Id='51688059' AND WorkspaceId='3820334'
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
The user's unique identifier. | |
WorkspaceId [KEY] | String | False |
The workspace's unique identifier. | |
Kind | String | False |
The user's role: subscriber or owner. All owners are by default also subscribers. This column can be used to filter non-owners. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
ActivityLogs | Get a board's log events. |
Assets | Get a collection of assets by ids. |
BoardViews | Get a board's views. |
Teams | Get a collection of teams. |
Users | Get a collection of users. |
Get a board's log events.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM ActivityLogs WHERE BoardId IN ('2307103055', '2182296646')
SELECT * FROM ActivityLogs WHERE UserId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE ColumnId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE GroupId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE ItemId IN ('27278379', '28087608')
SELECT * FROM ActivityLogs WHERE CreatedAt > '2022-02-17 05:12:04.419' AND CreatedAt < '2022-02-17 05:12:04.861'
SELECT * FROM ActivityLogs WHERE CreatedAt >= '2022-02-17 05:12:04.419' AND CreatedAt <= '2022-02-17 05:12:04.861'
Name | Type | References | Description |
Id [KEY] | String | The ID of the activity log event. | |
BoardId | String |
Boards.id | The unique identifier of the board. |
AccountId | String | The account ID that initiated the event. | |
UserId | String |
Users.Id | The user ID of the user who initiated the event. |
CreatedAt | Datetime | The time of the event. | |
Data | String | The item's column values in string form. | |
Entity | String | The entity of the event that was changed (pulse / board). | |
Event | String | The action that took place. | |
ColumnId | String | Column id to filter. | |
GroupId | String |
Groups.Id | Group id to filter. |
ItemId | String | Item id to filter. |
Get a collection of assets by ids.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM Assets WHERE Id = '397532775'
SELECT * FROM Assets WHERE Id IN ('397532775', '397532776')
Name | Type | References | Description |
Id [KEY] | String | The file's unique identifier. | |
Name | String | The file's name. | |
CreatedAt | Datetime | The file's creation date. | |
FileExtension | String | The file's extension. | |
FileSize | Int | The file's size in bytes. | |
OriginalGeometry | String | The original geometry of the asset. | |
PublicUrl | String | The public url to the asset, valid for 1 hour. | |
UploadedById | String |
Users.Id | The user's unique identifier. |
Url | String | The url to view the asset. | |
UrlThumbnail | String | The url to view the asset in thumbnail mode. Only available for images. |
Get a board's views.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM BoardViews WHERE BoardId = '2182296646'
SELECT * FROM BoardViews WHERE Type = 'Chart'
SELECT * FROM BoardViews WHERE BoardId IN ('2182296646', '2181960030')
Name | Type | References | Description |
Id [KEY] | String | The view's unique identifier. | |
BoardId | String |
Boards.Id | The unique identifier of the board. |
Name | String | The view's name. | |
Settings | String | The view's settings in a string form. | |
Type | String | The view's type. | |
ViewSpecificData | String | Specific board view data (supported only for forms). | |
SourceViewId | String | The view's template id if it was duplicated from another view. |
Get a collection of teams.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM Teams WHERE Id = '565332'
SELECT * FROM Teams WHERE Id IN ('565332, 565333')
Name | Type | References | Description |
Id [KEY] | String | The team's unique identifier. | |
Name | String | The team's name. | |
PictureUrl | String | The team's picture url. |
Get a collection of users.
The Cloud uses the Monday API to process some of the filters. The Cloud processes other filters client-side within the Cloud. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data.
SELECT * FROM Users ORDER BY CreatedAt DESC
SELECT * FROM Users WHERE IsPending = true
SELECT * FROM Users WHERE IsGuest = true
SELECT * FROM Users WHERE ID = '27278379'
SELECT * FROM Users WHERE ID IN ('27278379', '27278377')
SELECT * FROM Users WHERE Email = '[email protected]'
SELECT * FROM Users WHERE Email IN ('[email protected]', '[email protected]')
Name | Type | References | Description |
Id [KEY] | String | The user's unique identifier. | |
TeamsIds | String |
Teams.Id | A list of teams unique identifiers to which the user belongs. |
Name | String | The user's name. | |
Phone | String | The user's phone number. | |
Birthday | Date | The user's birthday. | |
CurrentLanguage | String | The current user's language. | |
CountryCode | String | The user's country code. | |
CreatedAt | Datetime | The user's creation date. | |
LastActivity | Datetime | Last date and time when user was active. | |
String | The user's email. | ||
Enabled | Bool | Whether or not the user is enabled. | |
IsAdmin | Bool | Whether or not the user is an account admin. | |
IsGuest | Bool | Whether or not the user is a guest. | |
IsPending | Bool | Whether or not the user is a pending user | |
IsVerified | Bool | Whether or not the user verified their email. | |
IsViewOnly | Bool | Whether or not the user is a view only user. | |
JoinDate | Date | The date the user joined the account. | |
Location | String | The user's location. | |
MobilePhone | String | The user's mobile phone number. | |
PhotoOriginal | String | The user's photo in the original size. | |
PhotoSmall | String | The user's photo in small size (150x150). | |
PhotoThumb | String | The user's photo in thumbnail size (100x100). | |
PhotoThumbSmall | String | The user's photo in small thumbnail size (50x50). | |
PhotoTiny | String | The user's photo in tiny size (30x30). | |
TimeZoneIdentifier | String | The user's timezone identifier. | |
Title | String | The user's title. | |
Url | String | The user's profile url. | |
UtcHoursDiff | Int | The user's utc hours difference. | |
SignUpProductKind | String | The product to which the user signed up to first. | |
AccountFirstDayOfTheWeek | String | The first day of the week for the account (sunday / monday) | |
AccountId | String | The account's unique identifier. | |
AccountLogo | String | The account's logo. | |
AccountName | String | The account's name. | |
AccountPlanMaxUsers | Int | The maximum users allowed in the plan. | |
AccountPlanPeriod | String | The plan's time period. | |
AccountPlanTier | String | The plan's tier. | |
AccountPlanVersion | Int | The plan's version. | |
AccountShowTimelineWeekends | Bool | Whether or not to show weekends in the timeline. | |
AccountSlug | String | The account's slug. | |
AccountTier | String | The account's tier. | |
AccountCountryCode | String | The account's country two-letter code in ISO3166 format. | |
AccountSignUpProductKind | String | The product the account signed up to first. | |
AccountProducts | String | The account's active products. | |
OutOfOfficeActive | Bool | Is the status active? | |
OutOfOfficeDisableNotifications | Bool | Are notification disabled? | |
OutOfOfficeStartDate | Date | The status start date. | |
OutOfOfficeEndDate | Date | The status end date. | |
OutOfOfficeType | String | Out of office type. | |
NonActive | Bool | Return non active users in the account. |
ストアドプロシージャはファンクションライクなインターフェースで、Monday の単純なSELECT 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMonday から関連するレスポンスデータを返します。
Name | Description |
AddFileToColumn | Add a file to a column value. |
AddFileToUpdate | Add a file to an update. |
BatchExtendTrialPeriod | Extends trial period of an application to selected accounts |
ClearItemUpdates | Clear an item's updates. |
CreateDocBlock | Create new document block |
CreateDocBoard | Create a new doc. |
CreateNotification | Create a new notification. |
DuplicateBoard | Duplicate a board. |
DuplicateGroup | Duplicate a group. |
DuplicateItem | Duplicate an item. |
LikeUpdate | Like an update. |
MoveItemToBoard | Move an item to a different board. |
RemoveMockAppSubscription | Remove mock app subscription for the current account |
SetMockAppSubscription | Set mock app subscription for the current account |
Add a file to a column value.
Name | Type | Required | Description |
ItemId | String | True | The item to add the file to. |
ColumnId | String | True | The column to add the file to. |
FileName | String | False | FileName is required when Content is specified. |
LocalPath | String | False | The file to upload. |
Name | Type | Description |
AssetId | String | The unique identifier of the uploaded file. |
Add a file to an update.
Name | Type | Required | Description |
UpdateId | String | True | The update to add the file to. |
FileName | String | False | FileName is required when Content is specified. |
LocalPath | String | False | The file to upload. |
Name | Type | Description |
AssetId | String | The unique identifier of the uploaded file. |
Extends trial period of an application to selected accounts
Name | Type | Required | Description |
AccountSlugs | String | True | A comma-separated list of the accounts' slags. Max: 5 |
AppId | String | True | The id of an application. |
PlanId | String | True | The id of a payment plan. |
DurationInDays | Integer | True | The amount of days to extend a trial period. Max: 365 |
Name | Type | Description |
Success | Boolean | Result of a batch operation. |
Reason | String | Reason of an error. |
Clear an item's updates.
Name | Type | Required | Description |
ItemId | String | True | The item's unique identifier. |
Name | Type | Description |
ItemId | String | The item's unique identifier. |
Create new document block
Name | Type | Required | Description |
DocId | String | True | The doc's unique identifier. |
AfterBlockId | String | False | After which block to insert this one. If not provided, will be inserted first in the document |
ParentBlockId | String | False | The parent block id to append the created block under. |
Type | String | True | The block's content type. |
Content | String | True | The block's content. |
Name | Type | Description |
DocumentBlockId | String | The document block's unique identifier. |
Create a new doc.
Name | Type | Required | Description |
ItemId | String | True | The item's unique identifier. |
ColumnId | String | True | The column's unique identifier. |
Name | Type | Description |
DocumentId | String | The document's unique identifier. |
Create a new notification.
Name | Type | Required | Description |
Text | String | True | The notification text. |
UserId | String | True | The user's unique identifier. |
TargetId | String | True | The target's unique identifier. |
TargetType | String | True | The target's type (Project / Post)
使用できる値は次のとおりです。Project, Post |
Name | Type | Description |
NotificationId | String | The notification's unique identifier. |
Duplicate a board.
Name | Type | Required | Description |
BoardId | String | True | The board's unique identifier. |
DuplicateType | String | True | The duplication type.
使用できる値は次のとおりです。duplicate_board_with_structure, duplicate_board_with_pulses, duplicate_board_with_pulses_and_updates |
BoardName | String | False | Optional the new board's name. If omitted then automatically generated |
WorkspaceId | String | False | Optional destination workspace. Defaults to the original board workspace. |
FolderId | String | False | Optional destination folder in destination workspace. Defaults to the original board folder. |
KeepSubscribers | Boolean | False | Duplicate the subscribers to the new board. Defaults to false. |
Name | Type | Description |
BoardId | String | The board's unique identifier. |
Duplicate a group.
Name | Type | Required | Description |
BoardId | String | True | The board's unique identifier. |
GroupId | String | True | The group's unique identifier. |
AddToTop | String | False | Should the new group be added to the top. |
GroupTitle | String | False | The group's title. |
Name | Type | Description |
GroupId | String | The group's unique identifier. |
Duplicate an item.
Name | Type | Required | Description |
BoardId | String | True | The board's unique identifier. |
WithUpdates | Boolean | False | Duplicate with the item's updates. |
ItemId | String | True | The item's unique identifier. |
Name | Type | Description |
ItemId | String | The item's unique identifier. |
Like an update.
Name | Type | Required | Description |
UpdateId | String | True | The update identifier. |
Name | Type | Description |
UpdateId | String | The update identifier. |
Move an item to a different board.
Name | Type | Required | Description |
BoardId | String | True | The unique identifier of a target board. |
GroupId | String | True | The unique identifier of a target group. |
ItemId | String | True | The unique identifier of an item to move. |
ColumnsMapping | String | False | Mapping of columns between the original board and target board |
SubitemsColumnsMapping | String | False | Mapping of subitem columns between the original board and target board |
Name | Type | Description |
ItemId | String | The item's unique identifier. |
Remove mock app subscription for the current account
Name | Type | Required | Description |
AppId | String | True | The app id of the app to remove the mocked subscription for. |
PartialSigningSecret | String | True | The last 10 characters of the app's signing secret. |
Name | Type | Description |
PlanId | String | The plan id for the mocked plan |
Set mock app subscription for the current account
Name | Type | Required | Description |
AppId | String | True | The app id of the app to mock subscription for. |
PartialSigningSecret | String | True | The last 10 characters of the app's signing secret. |
PlanId | String | False | The plan id for the mocked plan |
IsTrial | Boolean | False | Is the subscription a trial |
RenewalDate | Datetime | False | The subscription renewal date |
BillingPeriod | String | False | Billing period [monthly/yearly] |
PricingVersion | Int | False | Pricing plans version |
Name | Type | Description |
PlanId | String | The plan id for the mocked plan |
This section shows the available API objects and provides more information on executing SQL to Monday APIs.
ビュー are tables that cannot be modified. Typically, model data that is read-only and cannot be updated are shown as views.
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
AuditLogs | Get a board's audit log events. |
Get a board's audit log events.
All available values for the event filter are listed and explained below:
The following queries are executed server-side:
SELECT * FROM AuditLogs WHERE Timestamp >= '2022-01-01T07:30:00Z' AND Timestamp <= '2022-01-02T07:30:00Z'
SELECT * FROM AuditLogs WHERE Event IN ('export-board-activity-log', 'delete-board')
SELECT * FROM AuditLogs WHERE Timestamp >= '2022-01-01T07:30:00Z' AND Timestamp <= '2022-01-02T07:30:00Z' AND Event = 'delete-board' AND UserId = 27 AND IpAddress = '123.123'
Name | Type | References | Description |
Timestamp | Datetime | The timestamp of the event | |
AccountId | String | The account ID that initiated the event. | |
UserId | Integer | The user ID of the user who initiated the event. | |
Event | String | The action that took place.
使用できる値は次のとおりです。export-board-activity-log, export-account-data, download-attachment, export-board, export-dashboard, export-content-directory, login, forgot-password, logout, failed-login, user-reactivated, user-deactivated, user-details-deleted, user-invite, cancel-user-invite, user-role-change, delete-board, delete-workspace, create-team, delete-team, security-settings-change, board-broadcast-enabled, add-user-to-team, remove-user-from-team, add-user-to-product, remove-user-from-product, add-team-to-product, remove-team-from-product, api-complexity-breach-over-time | |
Slug | String | The slug of the event that took place. | |
IpAddress | String | The IP Address recorded for this event. | |
UserAgent | String | The User Agent of the event. | |
ClientName | String | Name of the software client. | |
ClientVersion | String | Version of the software client. | |
OsName | String | Name of the operating system. | |
OsVersion | String | Version of the operating system. | |
DeviceName | String | The name of the device. | |
DeviceType | String | The type of the device. | |
ActivityMetadata | String | Additional activity metadata for the event |
This section shows the available API objects and provides more information on executing SQL to Monday APIs.
テーブル are tables that can be modified.
ストアドプロシージャ are function-like interfaces to the data source.
Cloud はMonday のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
Board | An example board. |
BoardSubitems | An example subitems board. |
An example board.
Note that multiple filters are supported server-side provided they are all connected with either only AND or only OR logical operators.
The following columns are sorted server-side when including an ORDER BY clause:
The following queries are processed server side:
SELECT * FROM Board
SELECT * FROM Board WHERE ItemId = '5465844671'
SELECT * FROM Board WHERE ItemId IN ('5465844671','5465844679')
SELECT * FROM Board WHERE Item = 'Item 2'
SELECT * FROM Board WHERE Item != 'Item 2'
SELECT * FROM Board WHERE Item NOT IN ('Item 1','Item 2')
SELECT * FROM Board WHERE Item Contains 'Item'
SELECT * FROM Board WHERE CONTAINS(Item,'Item')
SELECT * FROM Board WHERE NOT CONTAINS(Item,'Item')
SELECT * FROM Board WHERE Check = True
SELECT * FROM Board WHERE Check != True
SELECT * FROM Board WHERE Check IS TRUE
SELECT * FROM Board WHERE Check IS NOT TRUE
SELECT * FROM Board WHERE Check = False
SELECT * FROM Board WHERE Check != False
SELECT * FROM Board WHERE Check IS FALSE
SELECT * FROM Board WHERE Check IS NOT FALSE
SELECT * FROM Board WHERE BoardRelationLinkedItemIds = ''
SELECT * FROM Board WHERE BoardRelationLinkedItemIds != ''
SELECT * FROM Board WHERE BoardRelationDisplayValue = ''
SELECT * FROM Board WHERE BoardRelationDisplayValue != ''
SELECT * FROM Board WHERE CountryCode = 'US'
SELECT * FROM Board WHERE CountryCode != 'US'
SELECT * FROM Board WHERE CountryCode IN ('US','UK')
SELECT * FROM Board WHERE CountryCode NOT IN ('US','UK')
SELECT * FROM Board WHERE CountryCode IS NULL
SELECT * FROM Board WHERE CountryCode IS NOT NULL
SELECT * FROM Board WHERE DependentOnDisplayValue = '[]'
SELECT * FROM Board WHERE DependentOnDisplayValue != '[]'
SELECT * FROM Board WHERE Hour='07:32:00'
SELECT * FROM Board WHERE Numbers IN (12, 55)
SELECT * FROM Board WHERE Numbers = 10
SELECT * FROM Board WHERE Numbers != 10
SELECT * FROM Board WHERE Numbers > 10
SELECT * FROM Board WHERE Numbers >= 10
SELECT * FROM Board WHERE Numbers < 10
SELECT * FROM Board WHERE Numbers <= 10
SELECT * FROM Board WHERE Text='test' AND Numbers=10
SELECT * FROM Board WHERE Text='test' OR Numbers=10
SELECT * FROM Board ORDER BY Item
SELECT * FROM Board ORDER BY CreatedAt
SELECT * FROM Board ORDER BY UpdatedAt
SELECT * FROM Board ORDER BY Numbers ASC NULLS LAST
INSERT statements are mapped to the 'create_item' GraphQL mutation.
The following inputs can be used in INSERT statements:
GroupId, ItemName, CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, Checkbox, CountryCode, CountryName, DateDate, DateDatetime, DependencyLinkedItemsIds, DropdownText, DropdownValue, Email, EmailLabel, Hour, LinkUrl, LinkUrlText, LocationLat, LocationLng, LocationAddress, LongText, Numbers, PeopleValue, PhoneCountryShortName, Phone, Rating, StatusIndex, StatusLabel, TagsIds, Text, TimelineFrom, TimelineTo, WeekStartDate, WeekEndDate, WorldClock
INSERT INTO Board (Item,GroupId,Check) VALUES ('Test','topics',true)
INSERT INTO Board (Item,GroupId,CountryCode,CountryName) VALUES ('Test','topics','US','United States')
INSERT INTO Board (Item,GroupId,Date) VALUES ('Test','topics','2023-11-16')
INSERT INTO Board (Item,GroupId,Datetime) VALUES ('Test','topics','2023-11-16 09:00:00.0-05:00')
INSERT INTO Board (Item,GroupId,DependentLinkedItemsIds) VALUES ('Test','topics','[5561036960, 5561037791]')
INSERT INTO Board (Item,GroupId,DropdownText) VALUES ('Test','topics','label1,label2')
INSERT INTO Board (Item,GroupId,DropdownText,CreateLabelsIfMissing) VALUES ('Test','topics','label3,label4','true')
INSERT INTO Board (Item,GroupId,DropdownValue) VALUES ('Test','topics','{"ids":[1,2]}')
INSERT INTO Board (Item,GroupId,Email,EmailLabel) VALUES ('Test','topics','[email protected]','Mail')
INSERT INTO Board (Item,GroupId,Hour) VALUES ('Test','topics','09:00:00')
INSERT INTO Board (Item,GroupId,LinkUrl,LinkUrlText) VALUES ('Test','topics','https://www.test.com/', 'TestLink')
INSERT INTO Board (Item,GroupId,LocationLat,LocationLng,LocationAddress) VALUES ('Test','topics',29.9772962,31.1324955,'Giza Pyramid Complex')
INSERT INTO Board (Item,GroupId,LongText) VALUES ('Test','topics','TestText')
INSERT INTO Board (Item,GroupId,Numbers) VALUES ('Test','topics','-10')
INSERT INTO Board (Item,GroupId,PeopleValue) VALUES ('Test','topics','{"personsAndTeams":[{"id":51688059,"kind":"person"},{"id":51085546,"kind":"person"}]}')
INSERT INTO Board (Item,GroupId,PhoneCountryShortName,Phone) VALUES ('Test','topics','US','12345678900')
INSERT INTO Board (Item,GroupId,Rating) VALUES ('Test','topics','5')
INSERT INTO Board (Item,GroupId,StatusIndex) VALUES ('Test','topics','2')
INSERT INTO Board (Item,GroupId,StatusIndex,StatusLabel,CreateLabelsIfMissing) VALUES ('Test','topics','15','NewLabel','true')
INSERT INTO Board (Item,GroupId,StatusLabel) VALUES ('Test','topics','Working on it')
INSERT INTO Board (Item,GroupId,TagsIds) VALUES ('Test','topics','[20826704,20826705]')
INSERT INTO Board (Item,GroupId,BoardLinkedItemIds) VALUES ('Test','topics','[5561037791,5561036960]')
INSERT INTO Board (Item,GroupId,Text) VALUES ('Test','topics','TestText')
INSERT INTO Board (Item,GroupId,TimelineFrom,TimelineTo) VALUES ('Test','topics','2023-11-01','2023-12-04')
INSERT INTO Board (Item,GroupId,WeekStartDate,WeekEndDate) VALUES ('Test','topics','2023-11-05','2023-11-11')
INSERT INTO Board (Item,GroupId,World_Clock) VALUES ('Test','topics','Africa/Algiers')
UPDATE statements are mapped to the 'change_multiple_column_values','move_item_to_group', and 'archive_item' GraphQL mutations.
The following inputs can be used in UPDATE statements:
ItemId, CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, Checkbox, CountryCode, CountryName, DateDate, DateDatetime, DependencyLinkedItemsIds, DropdownText, DropdownValue, Email, EmailLabel, Hour, LinkUrl, LinkUrlText, LocationLat, LocationLng, LocationAddress, LongText, Numbers, PeopleValue, PhoneCountryShortName, Phone, Rating, StatusIndex, StatusLabel, TagsIds, Text, TimelineFrom, TimelineTo, WeekStartDate, WeekEndDate, WorldClock, GroupId, State
Note that GroupId, State and column values cannot be updated in the same statement.
Also note that certain types require specifying all related columns to update the object's value (this includes Email, Link, Location, Phone, Timeline, Week).
UPDATE Board SET GroupId='new_group' WHERE ItemId='5562458608'
UPDATE Board SET State='archived' WHERE ItemId='5562458608'
UPDATE Board SET Check = false WHERE ItemId='5561890829'
UPDATE Board SET CountryCode='US',CountryName='United States' WHERE ItemId='5561890829'
UPDATE Board SET CountryCode=NULL,CountryName=NULL WHERE ItemId='5561890829'
UPDATE Board SET Date='2023-11-25' WHERE ItemId='5561890829'
UPDATE Board SET Date=NULL WHERE ItemId='5561890829'
UPDATE Board SET Datetime='2023-11-23 04:00:00.0' WHERE ItemId='5561890829'
UPDATE Board SET DependentLinkedItemsIds='[5562459384, 5562458774]' WHERE ItemId='5561890829'
UPDATE Board SET DependentLinkedItemsIds=NULL WHERE ItemId='5561890829'
UPDATE Board SET DropdownText='Label1,Label2' WHERE ItemId='5561890829'
UPDATE Board SET DropdownText='Label6,Label7',CreateLabelsIfMissing='true' WHERE ItemId='5561890829'
UPDATE Board SET DropdownValue='{"ids":[2,3]}' WHERE ItemId='5561890829'
UPDATE Board SET DropdownValue=NULL WHERE ItemId='5561890829'
UPDATE Board SET Email='[email protected]',EmailLabel='NewMail' WHERE ItemId='5561890829'
UPDATE Board SET Email=NULL,EmailLabel=NULL WHERE ItemId='5561890829'
UPDATE Board SET Hour='21:00:00' WHERE ItemId='5561890829'
UPDATE Board SET Hour=NULL WHERE ItemId='5561890829'
UPDATE Board SET LinkUrl='https://www.test.com',LinkUrlText='TestText' WHERE ItemId='5561890829'
UPDATE Board SET LinkUrl=NULL,LinkUrlText=NULL WHERE ItemId='5561890829'
UPDATE Board SET LocationAddress=NULL,LocationLat=NULL,LocationLng=NULL WHERE ItemId='5561890829'
UPDATE Board SET LocationLat='82',LocationLng='135',LocationAddress='TestLocation' WHERE ItemId='5561890829'
UPDATE Board SET LongText='changed text' WHERE ItemId='5561890829'
UPDATE Board SET LongText=NULL WHERE ItemId='5561890829'
UPDATE Board SET Numbers=10 WHERE ItemId='5561890829'
UPDATE Board SET Numbers=NULL WHERE ItemId='5561890829'
UPDATE Board SET PeopleValue='{"personsAndTeams":[{"id":51085546,"kind":"person"},{"id":961021,"kind":"team"}]}' WHERE ItemId='5561890829'
UPDATE Board SET PeopleValue=NULL WHERE ItemId='5561890829'
UPDATE Board SET Phone=NULL,PhoneCountryShortName=NULL WHERE ItemId='5561890829'
UPDATE Board SET PhoneCountryShortName='US',Phone='16102347959' WHERE ItemId='5561890829'
UPDATE Board SET Rating='1' WHERE ItemId='5561890829'
UPDATE Board SET Rating=NULL WHERE ItemId='5561890829'
UPDATE Board SET StatusIndex='2' WHERE ItemId='5561890829'
UPDATE Board SET StatusIndex=NULL WHERE ItemId='5561890829'
UPDATE Board SET StatusLabel='NewLabel',StatusIndex='159',CreateLabelsIfMissing='true' WHERE ItemId='5561890829'
UPDATE Board SET StatusLabel='Working on it' WHERE ItemId='5561890829'
UPDATE Board SET TagsIds='[20826705,20833783]' WHERE ItemId='5561890829'
UPDATE Board SET TagsIds=NULL WHERE ItemId='5561890829'
UPDATE Board SET BoardLinkedItemIds = NULL WHERE ItemId='5561890829'
UPDATE Board SET BoardLinkedItemIds='[5562459384, 5561890829, 5562458774]' WHERE ItemId='5561890829'
UPDATE Board SET Text='changedText' WHERE ItemId='5561890829'
UPDATE Board SET Text=NULL WHERE ItemId='5561890829'
UPDATE Board SET TimelineFrom='2023-01-01', TimelineTo='2023-10-10' WHERE ItemId='5561890829'
UPDATE Board SET TimelineFrom=NULL, TimelineTo=NULL WHERE ItemId='5561890829'
UPDATE Board SET WeekStartDate='2023-11-13', WeekEndDate='2023-11-19' WHERE ItemId='5561890829'
UPDATE Board SET WeekStartDate=NULL, WeekEndDate=NULL WHERE ItemId='5561890829'
UPDATE Board SET WorldClock='America/New York' WHERE ItemId='5561890829'
UPDATE Board SET WorldClock=NULL WHERE ItemId='5561890829'
DELETE statements are mapped to the 'delete_item' GraphQL mutation.
You can delete items by specifying the ItemId.
DELETE FROM Board WHERE ItemId='5561890829'
Name | Type | ReadOnly | References | Description |
ItemId [KEY] | String | False |
The item's unique identifier. | |
CreatorId | String | False |
The item's creator unique identifier. | |
CreatedAt | Datetime | False |
The item's create date. | |
UpdatedAt | Datetime | False |
The item's last updated date. | |
State | String | False |
The item's state (all, active, archived, deleted). | |
RelativeLink | String | False |
The item's relative path. | |
ItemEmail | String | False |
The item's email. | |
AssetsIds | String | False |
A comma separated list of the items' assets/files unique identifiers. | |
GroupId | String | False |
The title of the group that contains this item. | |
GroupTitle | String | False |
The title of the group that contains this item. | |
Item | String | False |
The item's name. | |
BoardRelationDisplayValue | String | False |
A string representing all the names of the linked items, separated by commas. | |
BoardRelationLinkedItemIds | String | False |
The linked item IDs. | |
ButtonLabel | String | False |
The button's label. | |
ButtonColor | String | False |
The button's color in hex value. | |
ButtonValue | String | False |
The column's value in json format. | |
Check | Bool | False |
The column's boolean value. | |
ColorPickerColor | String | False |
The color in hex value. | |
ColorPickerValue | String | False |
The column's value in json format. | |
CountryCode | String | False |
The country's two-letter code. | |
CountryName | String | False |
The country's name. | |
DateIcon | String | False |
The string representation of selected icon. | |
Date | Date | False |
The column's date value. | |
Datetime | Datetime | False |
The column's datetime value. | |
DependencyDisplayValue | String | False |
Choose the item your task will be dependent on. If the “dependent on” item’s date is changing, the other dates will adjust automatically A string representing all the names of the linked items, separated by commas. | |
DependencyLinkedItemsIds | String | False |
Choose the item your task will be dependent on. If the “dependent on” item’s date is changing, the other dates will adjust automatically The linked items ids. | |
DocFileId | String | False |
The file's unique identifier. | |
DocFileCreatorId | String | False |
The ID of user who created the file. | |
DocFileObjectId | String | False |
The associated board or object's unique identifier. | |
DocFileUrl | String | False |
The file's url. | |
DropdownText | String | False |
The column's textual value in string form. | |
DropdownValue | String | False |
The column's value in json format. | |
String | False |
The column's email value. | ||
EmailLabel | String | False |
The column's text value. It can be the same as email when user didn't enter any text. | |
FileText | String | False |
The column's textual value in string form. | |
FileValue | String | False |
The column's value in json format. | |
Hour | Time | False |
The column's time value. | |
IntegrationIssueId | String | False |
ID of the issue. | |
IntegrationEntityId | String | False |
ID of the entity. | |
IntegrationIssueApiUrl | String | False |
URL of the issue. | |
IntegrationValue | String | False |
The column's value in json format. | |
LastUpdated | String | False |
ID of the user who updated the item. | |
LinkUrl | String | False |
Url. | |
LinkUrlText | String | False |
Url text. | |
LocationLat | Double | False |
Latitude. | |
LocationLng | Double | False |
Longitude. | |
LocationPlaceId | String | False |
Place ID of the location. | |
LocationAddress | String | False |
Address. | |
LocationCity | String | False |
City. | |
LocationCityShort | String | False |
City. | |
LocationCountry | String | False |
Country. | |
LocationCountryShort | String | False |
Country short name (e.g. PE for Peru). | |
LocationStreet | String | False |
Street. | |
LocationStreetNumber | String | False |
Number of building in the street. | |
LocationStreetNumberShort | String | False |
Short number of building in the street. | |
LocationStreetShort | String | False |
Street. | |
LongText | String | False |
Long text. | |
MirrorDisplayValue | String | False |
The display value of the mirrored items' column. | |
MirroredItems | String | False |
The mirrored items. | |
Numbers | Double | False |
Number. | |
PeopleText | String | False |
The column's textual value in string form. | |
PeopleValue | String | False |
The column's value in json format. | |
PhoneCountryShortName | String | False |
ISO-2 country code. | |
Phone | String | False |
Phone number. | |
Rating | Int | False |
Rating value. | |
StatusIndex | Int | False |
The index of the status in the board. | |
StatusIsDone | Bool | False |
Whether the status is done. | |
StatusLabel | String | False |
The label of the status. | |
StatusUpdateId | String | False |
The ID of an update attached to the status. | |
StatusLabelStyleColor | String | False |
The style of the status label. The label's color in hex format. | |
StatusLabelStyleBorder | String | False |
The style of the status label. The label's border color in hex format. | |
TagsText | String | False |
The column's textual value in string form. | |
TagsIds | String | False |
Tag IDs. | |
Text | String | False |
The column's textual value in string form. | |
TimeTrackingRunning | Bool | False |
Whether the time tracker is running. | |
TimeTrackingStartedAt | Datetime | False |
The date when the time tracker was started. | |
TimeTrackingDuration | Int | False |
Total duration of the time tracker in seconds. | |
TimelineFrom | Date | False |
The start date of the timeline. | |
TimelineTo | Date | False |
The end date of the timeline. | |
TimelineVisualizationType | String | False |
The visualization type for the timeline. | |
VoteCount | Int | False |
The total number of votes. | |
VoterIds | String | False |
A list of IDs of users who voted. | |
WeekStartDate | Date | False |
The start date of the week. | |
WeekEndDate | Date | False |
The end date of the week. | |
WorldClock | String | False |
Timezone. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
CreateLabelsIfMissing | Bool |
Create Status/Dropdown labels if they're missing. Requires permission to change board structure. |
An example subitems board.
SELECT C.ItemId AS ChildId, C.Subitem AS ChildName, P.ItemId AS ParentId, P.Item AS ParentName FROM BoardSubitems C INNER JOIN Board P ON C.ParentItemId=P.ItemId
INSERT statements are mapped to the 'create_subitem' GraphQL mutation.
The following inputs can be used in INSERT statements:
ParentItemId, GroupId, ItemName, CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, Checkbox, CountryCode, CountryName, DateDate, DateDatetime, DependencyLinkedItemsIds, DropdownText, DropdownValue, Email, EmailLabel, Hour, LinkUrl, LinkUrlText, LocationLat, LocationLng, LocationAddress, LongText, Numbers, PeopleValue, PhoneCountryShortName, Phone, Rating, StatusIndex, StatusLabel, TagsIds, Text, TimelineFrom, TimelineTo, WeekStartDate, WeekEndDate, WorldClock
INSERT INTO BoardSubitems (ParentItemId, Subitem) VALUES ('5562458608','NewSubItem')
UPDATE statements are mapped to the 'change_multiple_column_values' GraphQL mutation.
The following inputs can be used in UPDATE statements:
ItemId, CreateLabelsIfMissing, BoardId, BoardRelationLinkedItemIds, Checkbox, CountryCode, CountryName, DateDate, DateDatetime, DependencyLinkedItemsIds, DropdownText, DropdownValue, Email, EmailLabel, Hour, LinkUrl, LinkUrlText, LocationLat, LocationLng, LocationAddress, LongText, Numbers, PeopleValue, PhoneCountryShortName, Phone, Rating, StatusIndex, StatusLabel, TagsIds, Text, TimelineFrom, TimelineTo, WeekStartDate, WeekEndDate, WorldClock
UPDATE BoardSubitems SET WorldClock='Europe/Amsterdam' WHERE ItemId='5573109452'
DELETE statements are mapped to the 'delete_item' GraphQL mutation.
You can delete entries by specifying the ItemId.
Name | Type | ReadOnly | References | Description |
ItemId [KEY] | String | False |
The item's unique identifier. | |
ParentItemId | String | False |
The item's parent unique identifier. | |
CreatorId | String | False |
The item's creator unique identifier. | |
CreatedAt | Datetime | False |
The item's create date. | |
UpdatedAt | Datetime | False |
The item's last updated date. | |
State | String | False |
The item's state (all, active, archived, deleted). | |
RelativeLink | String | False |
The item's relative path. | |
ItemEmail | String | False |
The item's email. | |
AssetsIds | String | False |
A comma separated list of the items' assets/files unique identifiers. | |
GroupId | String | False |
The title of the group that contains this item. | |
GroupTitle | String | False |
The title of the group that contains this item. | |
Subitem | String | False |
The item's name. | |
OwnerText | String | False |
The column's textual value in string form. | |
OwnerValue | String | False |
The column's value in json format. | |
StatusIndex | Int | False |
The index of the status in the board. | |
StatusIsDone | Bool | False |
Whether the status is done. | |
StatusLabel | String | False |
The label of the status. | |
StatusUpdateId | String | False |
The ID of an update attached to the status. | |
StatusLabelStyleColor | String | False |
The style of the status label. The label's color in hex format. | |
StatusLabelStyleBorder | String | False |
The style of the status label. The label's border color in hex format. | |
DateIcon | String | False |
The string representation of selected icon. | |
Date | Date | False |
The column's date value. | |
Datetime | Datetime | False |
The column's datetime value. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
CreateLabelsIfMissing | Bool |
Create Status/Dropdown labels if they're missing. Requires permission to change board structure. |
ストアドプロシージャはファンクションライクなインターフェースで、Monday の単純なSELECT 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMonday から関連するレスポンスデータを返します。
Name | Description |
AddFileToColumn | Add a file to a column value. |
AddFileToUpdate | Add a file to an update. |
BatchExtendTrialPeriod | Extends trial period of an application to selected accounts |
ClearItemUpdates | Clear an item's updates. |
CreateDocBlock | Create new document block |
CreateDocBoard | Create a new doc. |
CreateNotification | Create a new notification. |
DuplicateBoard | Duplicate a board. |
DuplicateGroup | Duplicate a group. |
DuplicateItem | Duplicate an item. |
LikeUpdate | Like an update. |
MoveItemToBoard | Move an item to a different board. |
RemoveMockAppSubscription | Remove mock app subscription for the current account |
SetMockAppSubscription | Set mock app subscription for the current account |
Add a file to a column value.
Name | Type | Required | Description |
ItemId | String | True | The item to add the file to. |
ColumnId | String | True | The column to add the file to. |
FileName | String | False | FileName is required when Content is specified. |
LocalPath | String | False | The file to upload. |
Name | Type | Description |
AssetId | String | The unique identifier of the uploaded file. |
Add a file to an update.
Name | Type | Required | Description |
UpdateId | String | True | The update to add the file to. |
FileName | String | False | FileName is required when Content is specified. |
LocalPath | String | False | The file to upload. |
Name | Type | Description |
AssetId | String | The unique identifier of the uploaded file. |
Extends trial period of an application to selected accounts
Name | Type | Required | Description |
AccountSlugs | String | True | A comma-separated list of the accounts' slags. Max: 5 |
AppId | String | True | The id of an application. |
PlanId | String | True | The id of a payment plan. |
DurationInDays | Integer | True | The amount of days to extend a trial period. Max: 365 |
Name | Type | Description |
Success | Boolean | Result of a batch operation. |
Reason | String | Reason of an error. |
Clear an item's updates.
Name | Type | Required | Description |
ItemId | String | True | The item's unique identifier. |
Name | Type | Description |
ItemId | String | The item's unique identifier. |
Create new document block
Name | Type | Required | Description |
DocId | String | True | The doc's unique identifier. |
AfterBlockId | String | False | After which block to insert this one. If not provided, will be inserted first in the document |
ParentBlockId | String | False | The parent block id to append the created block under. |
Type | String | True | The block's content type. |
Content | String | True | The block's content. |
Name | Type | Description |
DocumentBlockId | String | The document block's unique identifier. |
Create a new doc.
Name | Type | Required | Description |
ItemId | String | True | The item's unique identifier. |
ColumnId | String | True | The column's unique identifier. |
Name | Type | Description |
DocumentId | String | The document's unique identifier. |
Create a new notification.
Name | Type | Required | Description |
Text | String | True | The notification text. |
UserId | String | True | The user's unique identifier. |
TargetId | String | True | The target's unique identifier. |
TargetType | String | True | The target's type (Project / Post)
使用できる値は次のとおりです。Project, Post |
Name | Type | Description |
NotificationId | String | The notification's unique identifier. |
Duplicate a board.
Name | Type | Required | Description |
BoardId | String | True | The board's unique identifier. |
DuplicateType | String | True | The duplication type.
使用できる値は次のとおりです。duplicate_board_with_structure, duplicate_board_with_pulses, duplicate_board_with_pulses_and_updates |
BoardName | String | False | Optional the new board's name. If omitted then automatically generated |
WorkspaceId | String | False | Optional destination workspace. Defaults to the original board workspace. |
FolderId | String | False | Optional destination folder in destination workspace. Defaults to the original board folder. |
KeepSubscribers | Boolean | False | Duplicate the subscribers to the new board. Defaults to false. |
Name | Type | Description |
BoardId | String | The board's unique identifier. |
Duplicate a group.
Name | Type | Required | Description |
BoardId | String | True | The board's unique identifier. |
GroupId | String | True | The group's unique identifier. |
AddToTop | String | False | Should the new group be added to the top. |
GroupTitle | String | False | The group's title. |
Name | Type | Description |
GroupId | String | The group's unique identifier. |
Duplicate an item.
Name | Type | Required | Description |
BoardId | String | True | The board's unique identifier. |
WithUpdates | Boolean | False | Duplicate with the item's updates. |
ItemId | String | True | The item's unique identifier. |
Name | Type | Description |
ItemId | String | The item's unique identifier. |
Like an update.
Name | Type | Required | Description |
UpdateId | String | True | The update identifier. |
Name | Type | Description |
UpdateId | String | The update identifier. |
Move an item to a different board.
Name | Type | Required | Description |
BoardId | String | True | The unique identifier of a target board. |
GroupId | String | True | The unique identifier of a target group. |
ItemId | String | True | The unique identifier of an item to move. |
ColumnsMapping | String | False | Mapping of columns between the original board and target board |
SubitemsColumnsMapping | String | False | Mapping of subitem columns between the original board and target board |
Name | Type | Description |
ItemId | String | The item's unique identifier. |
Remove mock app subscription for the current account
Name | Type | Required | Description |
AppId | String | True | The app id of the app to remove the mocked subscription for. |
PartialSigningSecret | String | True | The last 10 characters of the app's signing secret. |
Name | Type | Description |
PlanId | String | The plan id for the mocked plan |
Set mock app subscription for the current account
Name | Type | Required | Description |
AppId | String | True | The app id of the app to mock subscription for. |
PartialSigningSecret | String | True | The last 10 characters of the app's signing secret. |
PlanId | String | False | The plan id for the mocked plan |
IsTrial | Boolean | False | Is the subscription a trial |
RenewalDate | Datetime | False | The subscription renewal date |
BillingPeriod | String | False | Billing period [monthly/yearly] |
PricingVersion | Int | False | Pricing plans version |
Name | Type | Description |
PlanId | String | The plan id for the mocked plan |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Monday のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | データベース名。 |
SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベース。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | テーブル名またはビュー名。 |
TableType | String | テーブルの種類(テーブルまたはビュー)。 |
Description | String | テーブルまたはビューの説明。 |
IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Invoices テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Invoices'
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | カラムを含むテーブルまたはビューの名前。 |
ColumnName | String | カラム名。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | カラムのストレージサイズ。 |
DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
IsNullable | Boolean | カラムがNull を含められるかどうか。 |
Description | String | カラムの簡単な説明。 |
Ordinal | Int32 | カラムのシーケンスナンバー。 |
IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
IsHidden | Boolean | カラムが非表示かどうか。 |
IsArray | Boolean | カラムが配列かどうか。 |
IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベース。 |
SchemaName | String | ストアドプロシージャを含むスキーマ。 |
ProcedureName | String | ストアドプロシージャの名前。 |
Description | String | ストアドプロシージャの説明。 |
ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、SampleProcedure ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
ColumnName | String | ストアドプロシージャパラメータの名前。 |
Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | 数値データの小数点以下の桁数。 |
IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
IsArray | Boolean | パラメータが配列かどうか。 |
Description | String | パラメータの説明。 |
Ordinal | Int32 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、Invoices テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Invoices'
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
名前 | タイプ | 説明 |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前。 |
KeySeq | String | 主キーのシーケンス番号。 |
KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | インデックスを含むデータベースの名前。 |
SchemaName | String | インデックスを含むスキーマの名前。 |
TableName | String | インデックスを含むテーブルの名前。 |
IndexName | String | インデックス名。 |
ColumnName | String | インデックスに関連付けられたカラムの名前。 |
IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
このテーブルをクエリする際は、config 接続文字列を使用する必要があります。
jdbc:cdata:monday:config:
この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | 接続プロパティ名。 |
ShortDescription | String | 簡単な説明。 |
Type | String | 接続プロパティのデータ型。 |
Default | String | 明示的に設定されていない場合のデフォルト値。 |
Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
Required | Boolean | プロパティが接続に必要かどうか。 |
Category | String | 接続プロパティのカテゴリ。 |
IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
Ordinal | Int32 | パラメータのインデックス。 |
CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
名前 | 説明 | 有効な値 |
AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | サポートされている文字列関数。 | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | サポートされている数値関数。 | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | サポートされている日付および時刻関数。 | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | レプリケーション中にスキップされたテーブルを示します。 | |
REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
DIALECT | 使用するSQL ダイアレクトを示します。 | |
KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | 使用したいcacheOptions を指定する文字列値。 | |
ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
Name | Type | Description |
NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | データ変更処理から返された、データベース生成Id。 |
Batch | String | バッチの識別子。1 は単一処理。 |
Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
プロパティ | 説明 |
Schema | Specifies which Monday schema to use. |
AuthScheme | The type of authentication to use when connecting to Monday. |
APIToken | The API token obtained from your Monday account. |
Domain | Specify the domain of your Monday account. Necessary only for the AuditLog API tables. Example: https://yourdomain.monday.com |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
プロパティ | 説明 |
MaxPointsPerCall | Specifies how many points a call will cost. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
Schema | Specifies which Monday schema to use. |
AuthScheme | The type of authentication to use when connecting to Monday. |
APIToken | The API token obtained from your Monday account. |
Domain | Specify the domain of your Monday account. Necessary only for the AuditLog API tables. Example: https://yourdomain.monday.com |
Specifies which Monday schema to use.
string
""
Possible values include 'Information' for general views with information on your account, 'AuditLog' for the Audit Log API, and values corresponding to dynamically generated schemas based on the workspaces in your account.
The type of authentication to use when connecting to Monday.
string
"OAuth"
The API token obtained from your Monday account.
string
""
Admin Tab
If you are an admin user on your monday.com account, you are able to access your API tokens from the "Admin" tab with the following steps:
Developer Tab
If you are a member user on your monday.com account, you are able to access your API tokens from the Developer tab with the following steps:
Specify the domain of your Monday account. Necessary only for the AuditLog API tables. Example: https://yourdomain.monday.com
string
""
Specify the domain of your Monday account. Necessary only for the AuditLog API tables. Example: https://yourdomain.monday.com
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
string
""
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxPointsPerCall | Specifies how many points a call will cost. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
Specifies how many points a call will cost.
string
"100000"
The total cost of a single query cannot exceed 5,000,000 points at any given time. Trial and free accounts using personal API tokens cannot exceed 1,000,000 points per minute.
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
int
-1
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
string
""
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。