2 replies

Request to support `args` parameter in Convex Migrations

With Convex migrations I can use table indexes to only run the migration on a subset.

But I can't find a way to take in an argument for which subset to run it on. So every time I wanna change the customRangecustomRange query I'm forced to push a change.

Here's what I'd like to do:

export const validateRequiredField = migrations.define({
  table: "myTable",
  args: {
    organizationId: v.string(),
  },
  customRange: (query, args) =>
    query.withIndex("byorganizationid", (q) => q.eq("organizationId", args.organizationId)),
  migrateOne: async (_ctx, doc) => {
    console.log("Needs fixup: " + doc._id);
    // Shorthand for patching
    return { requiredField: "<unknown>" };
  },
});

export const validateRequiredField = migrations.define({
  table: "myTable",
  args: {
    organizationId: v.string(),
  },
  customRange: (query, args) =>
    query.withIndex("byorganizationid", (q) => q.eq("organizationId", args.organizationId)),
  migrateOne: async (_ctx, doc) => {
    console.log("Needs fixup: " + doc._id);
    // Shorthand for patching
    return { requiredField: "<unknown>" };
  },
});

But the argsargs parameter is not supported at the moment.

Convex Community•12mo ago•

2 replies

Noah

Request to support `args` parameter in Convex Migrations

export const validateRequiredField = migrations.define({
  table: "myTable",
  args: {
    organizationId: v.string(),
  },
  customRange: (query, args) =>
    query.withIndex("byorganizationid", (q) => q.eq("organizationId", args.organizationId)),
  migrateOne: async (_ctx, doc) => {
    console.log("Needs fixup: " + doc._id);
    // Shorthand for patching
    return { requiredField: "<unknown>" };
  },
});

export const validateRequiredField = migrations.define({
  table: "myTable",
  args: {
    organizationId: v.string(),
  },
  customRange: (query, args) =>
    query.withIndex("byorganizationid", (q) => q.eq("organizationId", args.organizationId)),
  migrateOne: async (_ctx, doc) => {
    console.log("Needs fixup: " + doc._id);
    // Shorthand for patching
    return { requiredField: "<unknown>" };
  },
});

But the argsargs parameter is not supported at the moment.

Continue the conversation

Join the Discord to ask follow-up questions and connect with the community

Convex Community

Where Convex builders ask questions, share what they're building.

16,350 Members

Join

Request to support `args` parameter in Convex Migrations

Request to support `args` parameter in Convex Migrations

Continue the conversation

Convex Community

Continue the conversation

Convex Community

Similar Threads