Converting string array tags to document references in Sanity schema

27 replies
Last updated: Jan 28, 2026
When I first set up my schema, I added tags in the form of strings - just giving a quick string array I could reference down the line. I'm now rethinking that and want to set up a separate tags schema. Is there an easy way to quickly convert my existing strings into references, or am I looking at a manual job to do that? 😂
AI Update

Good news - you don't have to do this manually! Sanity's migration toolkit is perfect for this exact scenario. Here's how to handle converting your string arrays to references:

The Approach

You'll use defineMigration to create a script that:

  1. Creates new tag documents from your unique strings
  2. Updates your content documents to reference those tags instead

Step-by-Step Process

1. Create your new tag schema first

// schemas/tag.ts
export default {
  name: 'tag',
  type: 'document',
  fields: [
    {
      name: 'title',
      type: 'string'
    }
  ]
}

2. Generate a migration

npx sanity@latest migration create convertTagsToReferences

3. Write the migration script

import {defineMigration, at, set, unset} from 'sanity/migrate'

export default defineMigration({
  title: 'Convert string tags to references',
  documentTypes: ['yourDocumentType'], // whatever type has the tags
  
  async *migrate(documents, context) {
    // First pass: collect all unique tag strings and create tag documents
    const uniqueTags = new Set<string>()
    
    for await (const doc of documents()) {
      if (doc.tags && Array.isArray(doc.tags)) {
        doc.tags.forEach(tag => uniqueTags.add(tag))
      }
    }
    
    // Create tag documents and build a mapping
    const tagMap = new Map<string, string>()
    for (const tagString of uniqueTags) {
      const tagId = `tag-${tagString.toLowerCase().replace(/\s+/g, '-')}`
      tagMap.set(tagString, tagId)
      
      yield {
        _type: 'tag',
        _id: tagId,
        title: tagString
      }
    }
    
    // Second pass: update documents to use references
    for await (const doc of documents()) {
      if (doc.tags && Array.isArray(doc.tags)) {
        const tagRefs = doc.tags.map(tagString => ({
          _type: 'reference',
          _ref: tagMap.get(tagString),
          _key: Math.random().toString(36).substr(2, 9)
        }))
        
        yield {
          id: doc._id,
          patch: {
            set: {
              tags: tagRefs
            }
          }
        }
      }
    }
  }
})

4. Test it first (dry run)

sanity migration run convertTagsToReferences

This shows you what will happen without making changes.

5. Run it for real

sanity migration run convertTagsToReferences --dataset <your-dataset>

Update Your Schema

Don't forget to update your original document schema to use references:

{
  name: 'tags',
  type: 'array',
  of: [{type: 'reference', to: [{type: 'tag'}]}]
}

Pro Tips

  • The migration tool handles batching automatically, so you won't hit rate limits
  • Always test with a dry run first
  • Consider backing up your dataset before running migrations on production
  • The migration is idempotent - you can run it multiple times safely if you structure it right

This approach saves you from hours of manual work and ensures consistency across all your documents. The migration toolkit is specifically designed for these kinds of schema refactors!

Show original thread
27 replies

Sanity – Build the way you think, not the way your CMS thinks

Sanity is the developer-first content operating system that gives you complete control. Schema-as-code, GROQ queries, and real-time APIs mean no more workarounds or waiting for deployments. Free to start, scale as you grow.

Was this answer helpful?