Soql Database Introspector Class Diagram Builder

• Class diagram builder workflow
• Complete introspection examples
• Common patterns
• Step-by-step tutorials
• Pro tips

🚀 Quick Start

# Make executable (first time)
chmod +x soql.sh

# Execute simple query
./soql.sh "SELECT Id, Name FROM Account LIMIT 10"

🔧 Tool Options

🔍 Common Workflows

Introspect an Object

# Get all fields
./soql.sh "SELECT QualifiedApiName, DataType, Label 
FROM FieldDefinition 
WHERE EntityDefinition.QualifiedApiName = 'Account' 
LIMIT 200"

# Get relationships
./soql.sh "SELECT QualifiedApiName, ReferenceTargetField, RelationshipName 
FROM FieldDefinition 
WHERE EntityDefinition.QualifiedApiName = 'Account' 
AND ReferenceTargetField != null"

Build Class Diagram

1. Identify objects you want to diagram
2. Introspect fields for each object (see examples.md)
3. Extract relationships using SOQL queries
4. Build Mermaid diagram using discovered information

See examples.md for complete workflows.

📋 Prerequisites

• curl - For HTTP requests
• jq - For JSON formatting (optional but recommended)

# Ubuntu/Debian
sudo apt-get install curl jq

# MacOS
brew install curl jq

📖 Learn More

• New to this tool? Start with soql-README.md
• Need query syntax? Check reference.md
• Want examples? See examples.md
• Building diagrams? Follow workflows in examples.md

🔄 Quick Reference

# List custom objects
./soql.sh "SELECT QualifiedApiName, Label FROM EntityDefinition WHERE QualifiedApiName LIKE '%__c'"

# Count records
./soql.sh --count "SELECT COUNT() FROM Account"

# Sample data
./soql.sh "SELECT FIELDS(ALL) FROM Account LIMIT 1"

For complete query reference, see reference.md.