Zeroday•3w ago

Convex type errors and modular folder structure

Hi, I just started using Convex and all of the documentation shows that the schema info should be in the schema.ts file. However, my files are starting to stack up and I would like to rather have things be modular having a schema folder with my schema files in it making it nice and clean to add more tables in separate files, however, when I did this I start to get lots of type issues. Such as: Argument of type '"profileId"' is not assignable to parameter of type 'never'. code: // Get links for this profile const links = await ctx.db .query("links") .withIndex("by_profile_id", q => q.eq("profileId", profile._id)) .filter(q => q.eq(q.field("isDeleted"), false)) .collect(); I'm opening this support ticket to ask if moving my schema into separate files within the schema folder is something that is supported/recommended and why these type issues started after doing this. Thanks!

1 Reply

erquhart•3w ago

Generally you would define tables in those files, and then have schema.ts import them and export defineSchema() with the definition using those imports. You can import objects with multiple named table definitions or individual table definitions so the table name itself is defined in schema.ts, whichever you prefer:

import objectWithMultipleTableDefinitions from './tables'
import singleTableDefinition from './table'

export defineSchema({
  ...objectWithMultipleTableDefinitions,
  whateverTableName: singleTableDefinition
})

import objectWithMultipleTableDefinitions from './tables'
import singleTableDefinition from './table'

export defineSchema({
  ...objectWithMultipleTableDefinitions,
  whateverTableName: singleTableDefinition
})

Convex type errors and modular folder structure

Did you find this page helpful?