Skip to main content
Version: Upcoming

ClientStockLocate

V8 Message Definiton

ClientStockLocate records contain locates quantities that clients have directly sourced. VLanBridge:FieldRename:coreClientFirm:clientFirm BridgeFromV7

METADATA

AttributeValue
Topic1725-client-borrow
MLink TokenClientControl
ProductSRControl
accessTypeSELECT

Table Definition

FieldTypeKeyDefault ValueComment
ticker_atenum - AssetTypePRI'None'
ticker_tsenum - TickerSrcPRI'None'
ticker_tkVARCHAR(12)PRI''
coreClientFirmVARCHAR(16)PRI''
locateFirmVARCHAR(6)PRI''typically a clearing firm or 3rd party locate desk
locatePoolVARCHAR(16)PRI''locate pool firm granting the locate
tradeDateDATEPRI'1900-01-01'
locateQuanINT0
isLocateExemptenum - YesNo'None'Yes ticker is locate exempt only allowed for market makers
locateSourceenum - LocateSource'None'
modifiedByVARCHAR(24)''user who last modified this record
modifiedInenum - SysEnvironment'None'
timestampDATETIME(6)'1900-01-01 00:00:00.000000'timestamp of last modification

PRIMARY KEY DEFINITION (Unique)

FieldSequence
ticker_tk1
ticker_at2
ticker_ts3
coreClientFirm4
locateFirm5
locatePool6
tradeDate7

CREATE TABLE EXAMPLE QUERY

CREATE TABLE `SRControl`.`MsgClientStockLocate` (
`ticker_at` ENUM('None','EQT','IDX','BND','CUR','COM','FUT','SYN','WAR','FLX','MUT','SPD','MM','MF','COIN','TOKEN','ANY') NOT NULL DEFAULT 'None',
`ticker_ts` ENUM('None','SR','NMS','CME','ICE','CFE','CBOT','NYMEX','COMEX','RUT','CIDX','ARCA','NYSE','OTC','NSDQ','MFQS','MIAX','DJI','CUSIP','ISIN','BXE','EUX','ANY','CXE','DXE','NXAM','NXBR','NXLS','NXML','NXOS','NXP','EUREX','CEDX','ICEFE') NOT NULL DEFAULT 'None',
`ticker_tk` VARCHAR(12) NOT NULL DEFAULT '',
`coreClientFirm` VARCHAR(16) NOT NULL DEFAULT '',
`locateFirm` VARCHAR(6) NOT NULL DEFAULT '' COMMENT 'typically a clearing firm (or 3rd party locate desk)',
`locatePool` VARCHAR(16) NOT NULL DEFAULT '' COMMENT 'locate pool @ firm granting the locate',
`tradeDate` DATE NOT NULL DEFAULT '1900-01-01',
`locateQuan` INT NOT NULL DEFAULT 0,
`isLocateExempt` ENUM('None','Yes','No') NOT NULL DEFAULT 'None' COMMENT 'Yes = ticker is locate exempt (only allowed for market makers)',
`locateSource` ENUM('None','SRSE','MLink','Tool') NOT NULL DEFAULT 'None',
`modifiedBy` VARCHAR(24) NOT NULL DEFAULT '' COMMENT 'user who last modified this record',
`modifiedIn` ENUM('None','Neptune','Pluto','V7_Stable','V7_Latest','Saturn','Venus','Mars','SysTest','V7_Current') NOT NULL DEFAULT 'None',
`timestamp` DATETIME(6) NOT NULL DEFAULT '1900-01-01 00:00:00.000000' COMMENT 'timestamp of last modification',
PRIMARY KEY USING HASH (`ticker_tk`,`ticker_at`,`ticker_ts`,`coreClientFirm`,`locateFirm`,`locatePool`,`tradeDate`)
) ENGINE=SRSE DEFAULT CHARSET=LATIN1 COMMENT='ClientStockLocate records contain locates quantities that clients have directly sourced.\nVLanBridge:FieldRename:coreClientFirm:clientFirm\nBridgeFromV7';

SELECT TABLE EXAMPLE QUERY

SELECT
`ticker_at`,
`ticker_ts`,
`ticker_tk`,
`coreClientFirm`,
`locateFirm`,
`locatePool`,
`tradeDate`,
`locateQuan`,
`isLocateExempt`,
`locateSource`,
`timestamp`
FROM `SRControl`.`MsgClientStockLocate`
WHERE
/* Replace with a ENUM('None','EQT','IDX','BND','CUR','COM','FUT','SYN','WAR','FLX','MUT','SPD','MM','MF','COIN','TOKEN','ANY') */
`ticker_at` = 'None'
AND
/* Replace with a ENUM('None','SR','NMS','CME','ICE','CFE','CBOT','NYMEX','COMEX','RUT','CIDX','ARCA','NYSE','OTC','NSDQ','MFQS','MIAX','DJI','CUSIP','ISIN','BXE','EUX','ANY','CXE','DXE','NXAM','NXBR','NXLS','NXML','NXOS','NXP','EUREX','CEDX','ICEFE') */
`ticker_ts` = 'None'
AND
/* Replace with a VARCHAR(12) */
`ticker_tk` = 'Example_ticker_tk'
AND
/* Replace with a VARCHAR(16) */
`coreClientFirm` = 'Example_coreClientFirm'
AND
/* Replace with a VARCHAR(6) */
`locateFirm` = 'Example_locateFirm'
AND
/* Replace with a VARCHAR(16) */
`locatePool` = 'Example_locatePool'
AND
/* Replace with a DATE */
`tradeDate` = '2022-01-01';

Doc Columns Query

SELECT * FROM SRControl.doccolumns WHERE TABLE_NAME='ClientStockLocate' ORDER BY ordinal_position ASC;