API Reference › core-backend› IModels › IModelDb › AttachDb

attachDb Method

Attach an iModel file to this connection and load and register its schemas.

attachDb(fileName: string, alias: string): void

@note There are some reserve tablespace names that cannot be used. They are 'main', 'schema_sync_db', 'ecchange' & 'temp'

Parameter Type Description
fileName string IModel file name
alias string identifier for the attached file. This identifer is used to access schema from the attached file. e.g. if alias is 'abc' then schema can be accessed using 'abc.MySchema.MyClass'

Example:
``` ts
async function attachSimulationDb(masterFile: LocalFileName, simulationFile: LocalFileName): Promise {
const master = SnapshotDb.openFile(masterFile);

// attach simulation db master.attachDb(simulationFile, "SimDb");

const ecsql = SELECT ts.TimeFromStart [Time From Start (s)], p.UserLabel [Pipe with Max Flow], MAX(ltvrr.Flow) [Max Flow (L/s)] FROM SimDb.simrescore.TimeStep ts INNER JOIN SimDb.stmswrres.BasicFlowResultRecord ltvrr ON ts.ECInstanceId = ltvrr.TimeStep.Id INNER JOIN swrhyd.Pipe p ON p.ECInstanceId = ltvrr.ElementId GROUP BY ts.ECInstanceId HAVING MAX(ltvrr.Flow) > 1 LIMIT 3;

const reader = master.createQueryReader(ecsql); const rows = []; while (await reader.step()) { rows.push(reader.current.toRow()); } const expected = [ { 'Time From Start (s)': 0, 'Pipe with Max Flow': 'CO-4', 'Max Flow (L/s)': 66.14359584163114 }, { 'Time From Start (s)': 3600, 'Pipe with Max Flow': 'CO-4', 'Max Flow (L/s)': 78.33925707748288 }, { 'Time From Start (s)': 7200, 'Pipe with Max Flow': 'CO-3', 'Max Flow (L/s)': 85.32875334207684 }, ]; expect(rows).to.deep.equal(expected);

// detach attached db master.detachDb("SimDb"); master.close(); }
``` |

Returns - void

Defined in

Last Updated: 26 April, 2025