Note that there are still some features that have not been completed, such as migrations and schema generation
\n\n## How To Use\n\n```bash\n# Clone this repository\n$ git clone https://github.com/soya-miruku/typed-surql\n```\n\n```ts\n ensure you have enabled the following in your tsconfig file:\n \"emitDecoratorMetadata\": true,\n \"experimentalDecorators\": true,\n```\n\n```ts\n# Or npm/bun\nimport { TypedSurQL } from '@soyamiruku/typed-surl';\n\n// initialise the connection\nTypedSurQL.Init(env.DB_URL, {\n\twebsocket: false, auth: {\n\t\tusername: env.DB_USER,\n\t\tpassword: env.DB_PASS\n\t},\n\tnamespace: env.DB_NAMESPACE,\n\tdatabase: env.DB_NAME\n});\n\n// wait until the connection is made\nawait TypedSurQL.Wait(5);\nimport { TypedSurQL, Model, Q, RelationEdge } from '@soyamiruku/typed-surl';\nimport { Lemons } from \"./lemons\";\n\n@Q.Table({ name: \"eats\" })\nexport class Eats extends RelationEdge { }\n\n@Q.Table({ name: \"user\" })\nexport class User extends Model {\n @Q.Field({ index: { name: \"username_idx\", search: true } }) username!: string;\n @Q.Field() something!: string;\n @Q.Relation(\"->\", Eats, \"->\", Lemons) readonly lemonsEaten!: Lemons[];\n}\n\n@Q.Table({ name: \"session\" })\nexport class Session extends Model {\n @Q.Field() active_expires!: number;\n @Q.Field() idle_expires!: number;\n @Q.Field() user!: User;\n}\n\n@Q.Table({ name: \"key\" })\nexport class Account extends Model {\n @Q.Field() hashed_password?: string | null;\n @Q.Field() key_id!: string;\n @Q.Field() user!: User;\n}\n\n// Defines the object types with only the properties\nexport type UserObject = Q.Static;\nexport type SessionObject = Q.Static;\nexport type AccountObject = Q.Static;\n\n// Perform queries\n\nconst result = await User.select(\"*\", { fetch: [\"lemonsEaten\"]});\n\n// query functions\n\nimport { query } from '@soyamiruku/typed-surl';\n\n// field param provides all surrealdb functions / operators and the table name as well allowing you to select the model properties:\n\nquery.queryModel(User, (q, field) => q`SELECT *, ${field.string.uppercase(field(\"username\")).as(\"cap_username\")} FROM ${field.TABLE} WHERE ${field(\"id\")} = ....`)\n// or you can do\nUser.query((q, { VALUE, TABLE, field }) => ....)....\n```\n\n```txt\n There is also an example folder with you can check out\n```\n\n> **Note**\n> There may be bugs\n\n## License\n\nMIT\n\n---\n\n> [soyamiruku](https://github.com/soya-miruku) ","readmeFilename":"README.md"}
![\"typed-surql\"](\"https://i.postimg.cc/5Nv9t960/file-JF5l-KVEp2mxqb-J94-Wk-F7h-O1-E.jpg\")
\n