AI SQL Query Generator - Documentation

Prerequisites

• An OpenAI account with API access.
• API key for authentication.
• Below is the example JSON structure of your database tables to pass as input.
"employeeTableStructure = {
    tableName: 'Employee',
    columns: [
        { name: 'Id', type: 'INTEGER', description: 'Unique identifier for the employee (Primary Key).' },
        { name: 'ProfileImage', type: 'BinaryData', description: 'Image of the employee.' },
        { name: 'EmployeeName', type: 'VARCHAR(50)', description: 'Name of the employee.' },
        { name: 'Email', type: 'VARCHAR(100)', description: 'Email address of the employee.' },
        { name: 'PhoneNumber', type: 'VARCHAR(15)', description: 'Contact phone number of the employee.' },
        { name: 'CompanyId', type: 'INTEGER', description: 'Foreign key referencing Company Table.' },
        { name: 'CreatedBy', type: 'INTEGER', description: 'Foreign key referencing User Table (Created by User ID).' }
    ]
};

skillTableStructure = {
    tableName: 'Skill',
    columns: [
        { name: 'Id', type: 'INTEGER', description: 'Unique identifier for the skill (Primary Key).' },
        { name: 'SkillName', type: 'VARCHAR(100)', description: 'Name of the skill.' },
        { name: 'Rating', type: 'INTEGER', description: 'Skill rating (1 to 5 stars).' },
        { name: 'EmployeeId', type: 'INTEGER', description: 'Foreign key referencing Employee Table (One-to-Many relationship).' }
    ]
};
companyTableStructure = {
    tableName: 'Company',
    columns: [
        { name: 'Id', type: 'INTEGER', description: 'Unique identifier for the company (Primary Key).' },
        { name: 'CompanyName', type: 'VARCHAR(100)', description: 'Name of the company.' },
        { name: 'Logo', type: 'Binary Data', description: 'Binary data representing the company logo.' },
        { name: 'Email', type: 'VARCHAR(100)', description: 'Official email address of the company.' },
        { name: 'Industry', type: 'VARCHAR(50)', description: 'Industry to which the company belongs.' }
    ]
};"