appwrite-utils-cli/dist/examples/yamlTerminologyExample.d.ts

Appwrite Utility Functions to help with database management, data conversion, data import, migrations, and much more. Meant to be used as a CLI tool, I do not recommend installing this in frontend environments.

/**
 * Example demonstrating YAML import/export with dual terminology support
 *
 * This example shows how to:
 * 1. Generate YAML files for both collections and tables
 * 2. Load and convert between terminologies
 * 3. Validate terminology consistency
 * 4. Migrate between formats
 */
import { type CollectionCreate } from "appwrite-utils";
/**
 * Example 1: Generate YAML templates for both collection and table formats
 */
export declare function generateTemplateExamples(outputDir: string): Promise<void>;
/**
 * Example 2: Convert existing collection definition to different formats
 */
export declare function convertCollectionFormats(collection: CollectionCreate): void;
/**
 * Example 3: Load and process YAML files with mixed terminologies
 */
export declare function processYamlFiles(baseDir: string): Promise<void>;
/**
 * Example 4: Migrate between terminologies
 */
export declare function migrateTerminology(baseDir: string): Promise<void>;
/**
 * Example 5: Validate terminology consistency
 */
export declare function validateTerminology(baseDir: string): Promise<void>;
/**
 * Example 6: Import configuration with terminology support
 */
export declare function importConfigurationExample(appwriteFolderPath: string): Promise<void>;
/**
 * Example 7: Manual terminology conversion
 */
export declare function manualTerminologyConversion(): void;
/**
 * Main example runner
 */
export declare function runYamlTerminologyExamples(outputDir: string): Promise<void>;