Nuxt Neo4j
轻松将 Neo4j 强大的图数据库集成到您的 Nuxt 应用程序中!
功能
- 轻松集成:只需一行配置即可设置数据库。
- DevTools 支持:您将能够从 Nuxt DevTools 访问 neo4j 的工作区!
- 易于使用:该模块提供一个
useDriver
函数,以便轻松与数据库交互。 - 开发者体验:此模块使用官方的
neo4j-driver
,因此它完全支持 typescript。
安装
- 将
nuxt-neo4j
依赖项添加到您的项目中
# Using pnpm
pnpm add -D nuxt-neo4j
# Using yarn
yarn add --dev nuxt-neo4j
# Using npm
npm install --save-dev nuxt-neo4j
- 将
nuxt-neo4j
添加到nuxt.config.ts
的modules
部分
export default defineNuxtConfig({
modules: [
'nuxt-neo4j',
],
})
就是这样!您现在可以在您的 Nuxt 应用程序中使用 Nuxt Neo4j 了 ✨
配置
export default defineNuxtConfig({
neo4j: {
uri: 'string', // @default: process.env.NEO4J_URI
auth: {
type: 'string', // @default: 'basic'
username: 'string', // @default: process.env.NEO4J_USERNAME
password: 'string', // @default: process.env.NEO4J_PASSWORD
},
},
})
用法
配置完成后,您就可以开始在您的 Nuxt 应用程序中使用该模块提供的 Neo4j 驱动程序了。这是一个 示例,展示了如何使用它
export default defineEventHandler(async () => {
const { records } = await useDriver().executeQuery('MATCH (q:User) RETURN q LIMIT 25;')
return records
})
有关更多信息,请查看 neo4j 文档
开发
# Install dependencies
pnpm install
# Generate type stubs
pnpm run dev:prepare
# Develop with the playground
pnpm run dev
# Build the playground
pnpm run dev:build
# Run ESLint
pnpm run lint
# Run Vitest
pnpm run test
pnpm run test:watch
# Release new version
pnpm run release