Refactor/rename skip to offset

docs/asciidoc/guides/migration-guide/queries.adoc

@@ -34,7 +34,7 @@ Changes to note for migration:
 * Query fields were previously named in the singular, and in _PascalCase_ - they are now pluralized and in _camelCase_
 * Query return types were previously in nullable lists of nullable types - they are now non-nullable lists of non-nullable types, _e.g._ `[Movie]` is now `[Movie!]!`; ensuring either an array of defined `Movie` objects or an empty array.
 * In this example, the `_MovieFilter` type has essentially been renamed to `MovieWhere`, the `filter` arguments renamed to `where`, and the top-level field arguments `title` and `averageRating` removed - see <<migration-guide-queries-filtering>> below
-* The `first`, `offset` and `orderBy` have been collapsed into the `MovieOptions` type and renamed `limit`, `skip` and `sort`, respectively - see <<migration-guide-queries-options>> below
+* The `first`, `offset` and `orderBy` have been collapsed into the `MovieOptions` type and renamed `limit`, `offset` and `sort`, respectively - see <<migration-guide-queries-options>> below
 
 [[migration-guide-queries-filtering]]
 == Filtering (`where`)
@@ -206,7 +206,7 @@ Using `@neo4j/graphql`, this will now be:
 [source, graphql]
 ----
 query {
-    movies(options: { skip: 20, limit: 10 }) {
+    movies(options: { offset: 20, limit: 10 }) {
         title
     }
 }

docs/asciidoc/ogm/getting-started.adoc

@@ -47,14 +47,14 @@ const User = ogm.model("User");
 
 const app = express();
 app.get("/users", async (req, res) => {
-    const { search, skip, limit, sort } = req.query;
+    const { search, offset, limit, sort } = req.query;
 
     const regex = search ? `(?i).*${search}.*` : null;
 
     const users = await User.find({
         where: { name_REGEX: regex },
         options: {
-            skip,
+            offset,
             limit,
             sort
         }

docs/asciidoc/schema/pagination.adoc

@@ -3,7 +3,7 @@
 
 == Page-based pagination
 
-Page-based pagination can be achieved through the use of the `skip` and `limit` options available whilst querying for data.
+Page-based pagination can be achieved through the use of the `offset` and `limit` options available whilst querying for data.
 
 Using the following type definition:
 
@@ -27,14 +27,14 @@ query {
 }
 ----
 
-And then on subsequent calls, introduce the `skip` argument and increment it by 10 on each call.
+And then on subsequent calls, introduce the `offset` argument and increment it by 10 on each call.
 
 Page 2:
 [source, graphql]
 ----
 query {
     users(options: {
-        skip: 10
+        offset: 10
         limit: 10
     }) {
         name
@@ -47,7 +47,7 @@ Page 3:
 ----
 query {
     users(options: {
-        skip: 20
+        offset: 20
         limit: 10
     }) {
         name
@@ -67,7 +67,7 @@ query {
     }) {
         name
         posts(options: {
-            skip: 20
+            offset: 20
             limit: 10
         }) {
             content

docs/asciidoc/schema/sorting.adoc

@@ -36,7 +36,7 @@ input MovieOptions {
     """Specify one or more MovieSort objects to sort Movies by. The sorts will be applied in the order in which they are arranged in the array."""
     sort: [MovieSort]
     limit: Int
-    skip: Int
+    offset: Int
 }
 
 type Query {

examples/neo-push/README.md

@@ -142,10 +142,10 @@ Once logged in users are directed to the dashboard page;
 ![dashboard](assets/dashboard.jpg)
 
 ```graphql
-query myBlogs($id: ID, $skip: Int, $limit: Int, $hasNextBlogsSkip: Int) {
+query myBlogs($id: ID, $offset: Int, $limit: Int, $hasNextBlogsoffset: Int) {
     myBlogs: blogs(
         where: { OR: [{ creator: { id: $id } }, { authors: { id: $id } }] }
-        options: { limit: $limit, skip: $skip, sort: { createdAt: DESC } }
+        options: { limit: $limit, offset: $offset, sort: { createdAt: DESC } }
     ) {
         id
         name
@@ -159,7 +159,7 @@ query myBlogs($id: ID, $skip: Int, $limit: Int, $hasNextBlogsSkip: Int) {
         where: { OR: [{ creator: { id: $id } }, { authors: { id: $id } }] }
         options: {
             limit: 1
-            skip: $hasNextBlogsSkip
+            offset: $hasNextBlogsoffset
             sort: { createdAt: DESC }
         }
     ) {

examples/neo-push/client/src/components/Blog.tsx

@@ -138,7 +138,7 @@ function CreatePost({ close, blog }: { close: () => void; blog: BlogInterface })
 
 function BlogPosts({ blog }: { blog: BlogInterface }) {
     const { query } = useContext(graphql.Context);
-    const [skip, setSkip] = useState(0);
+    const [offset, setOffset] = useState(0);
     const [limit] = useState(10);
     const [hasMore, setHasMore] = useState(false);
     const [posts, setPosts] = useState<PostInterface[]>([]);
@@ -150,9 +150,9 @@ function BlogPosts({ blog }: { blog: BlogInterface }) {
                 query: BLOG_POSTS,
                 variables: {
                     blog: blog.id,
-                    skip: posts.length,
+                    offset: posts.length,
                     limit,
-                    hasNextPostsSkip: posts.length === 0 ? limit : posts.length + 1,
+                    hasNextPostsOffset: posts.length === 0 ? limit : posts.length + 1,
                 },
             });
 
@@ -161,11 +161,11 @@ function BlogPosts({ blog }: { blog: BlogInterface }) {
         } catch (e) {}
 
         setLoading(false);
-    }, [skip, posts]);
+    }, [offset, posts]);
 
     useEffect(() => {
         getPosts();
-    }, [skip]);
+    }, [offset]);
 
     if (loading) {
         <Card className="mt-3 p-3">
@@ -190,7 +190,7 @@ function BlogPosts({ blog }: { blog: BlogInterface }) {
             </Row>
             {hasMore && (
                 <div className="d-flex justify-content-center w-100">
-                    <Button onClick={() => setSkip((s) => s + 1)}>Load More</Button>
+                    <Button onClick={() => setOffset((s) => s + 1)}>Load More</Button>
                 </div>
             )}
         </Card>

examples/neo-push/client/src/components/Dashboard.tsx

@@ -114,7 +114,7 @@ function BlogItem(props: { blog: any; updated?: boolean }) {
 function MyBlogs() {
     const { getId } = useContext(auth.Context);
     const { query } = useContext(graphql.Context);
-    const [skip, setSkip] = useState(0);
+    const [offset, setOffset] = useState(0);
     const [limit] = useState(10);
     const [myBlogsHasMore, setMyBlogsHasMore] = useState(false);
     const [blogs, setBlogs] = useState<BlogInterface[]>([]);
@@ -128,9 +128,9 @@ function MyBlogs() {
                 query: MY_BLOGS,
                 variables: {
                     id: getId(),
-                    skip: blogs.length,
+                    offset: blogs.length,
                     limit,
-                    hasNextBlogsSkip: blogs.length === 0 ? limit : blogs.length + 1,
+                    hasNextBlogsOffset: blogs.length === 0 ? limit : blogs.length + 1,
                 },
             });
 
@@ -139,11 +139,11 @@ function MyBlogs() {
         } catch (e) {}
 
         setLoading(false);
-    }, [skip, blogs, limit]);
+    }, [offset, blogs, limit]);
 
     useEffect(() => {
         getBlogs();
-    }, [skip]);
+    }, [offset]);
 
     if (loading) {
         <Card className="mt-3 p-3">
@@ -163,7 +163,7 @@ function MyBlogs() {
                 ))}
             </Row>
             {myBlogsHasMore && (
-                <div className="d-flex justify-content-center w-100" onClick={() => setSkip((s) => s + 1)}>
+                <div className="d-flex justify-content-center w-100" onClick={() => setOffset((s) => s + 1)}>
                     <Button>Load More</Button>
                 </div>
             )}
@@ -174,7 +174,7 @@ function MyBlogs() {
 function RecentlyUpdatedBlogs() {
     const { query } = useContext(graphql.Context);
     const [limit] = useState(10);
-    const [skip, setSkip] = useState(0);
+    const [offset, setOffset] = useState(0);
     const [myBlogsHasMore, setMyBlogsHasMore] = useState(false);
     const [blogs, setBlogs] = useState<BlogInterface[]>([]);
     const [loading, setLoading] = useState(true);
@@ -185,9 +185,9 @@ function RecentlyUpdatedBlogs() {
             const response = await query({
                 query: RECENTLY_UPDATED_BLOGS,
                 variables: {
-                    skip: blogs.length,
+                    offset: blogs.length,
                     limit,
-                    hasNextBlogsSkip: blogs.length === 0 ? limit : blogs.length + 1,
+                    hasNextBlogsOffset: blogs.length === 0 ? limit : blogs.length + 1,
                 },
             });
 
@@ -196,11 +196,11 @@ function RecentlyUpdatedBlogs() {
         } catch (e) {}
 
         setLoading(false);
-    }, [skip, blogs]);
+    }, [offset, blogs]);
 
     useEffect(() => {
         getBlogs();
-    }, [skip]);
+    }, [offset]);
 
     if (loading) {
         <Card className="mt-3 p-3">
@@ -220,7 +220,7 @@ function RecentlyUpdatedBlogs() {
                 ))}
             </Row>
             {myBlogsHasMore && (
-                <div className="d-flex justify-content-center w-100" onClick={() => setSkip((s) => s + 1)}>
+                <div className="d-flex justify-content-center w-100" onClick={() => setOffset((s) => s + 1)}>
                     <Button>Load More</Button>
                 </div>
             )}

examples/neo-push/client/src/components/Post.tsx

@@ -396,7 +396,7 @@ function PostComments({
     setComments: (cb: (comments: Comment[]) => any) => void;
 }) {
     const { query } = useContext(graphql.Context);
-    const [skip, setSkip] = useState(0);
+    const [offset, setOffset] = useState(0);
     const [limit] = useState(10);
     const [hasMore, setHasMore] = useState(false);
     const [loading, setLoading] = useState(true);
@@ -408,9 +408,9 @@ function PostComments({
                 query: POST_COMMENTS,
                 variables: {
                     post,
-                    skip: comments.length,
+                    offset: comments.length,
                     limit,
-                    hasNextCommentsSkip: comments.length === 0 ? limit : comments.length + 1,
+                    hasNextCommentsOffset: comments.length === 0 ? limit : comments.length + 1,
                 },
             });
 
@@ -423,11 +423,11 @@ function PostComments({
         }
 
         setLoading(false);
-    }, [skip]);
+    }, [offset]);
 
     useEffect(() => {
         getComments();
-    }, [skip]);
+    }, [offset]);
 
     if (error) {
         return (
@@ -463,7 +463,7 @@ function PostComments({
             ))}
             {hasMore && (
                 <div className="d-flex justify-content-center w-100 mt-3">
-                    <Button onClick={() => setSkip((s) => s + 1)}>Load More</Button>
+                    <Button onClick={() => setOffset((s) => s + 1)}>Load More</Button>
                 </div>
             )}
         </>

examples/neo-push/client/src/queries.ts

@@ -33,10 +33,10 @@ export const CREATE_BLOG = gql`
 `;
 
 export const MY_BLOGS = gql`
-    query myBlogs($id: ID, $skip: Int, $limit: Int, $hasNextBlogsSkip: Int) {
+    query myBlogs($id: ID, $offset: Int, $limit: Int, $hasNextBlogsOffset: Int) {
         myBlogs: blogs(
             where: { OR: [{ creator: { id: $id } }, { authors: { id: $id } }] }
-            options: { limit: $limit, skip: $skip, sort: { createdAt: DESC } }
+            options: { limit: $limit, offset: $offset, sort: { createdAt: DESC } }
         ) {
             id
             name
@@ -48,16 +48,16 @@ export const MY_BLOGS = gql`
         }
         hasNextBlogs: blogs(
             where: { OR: [{ creator: { id: $id } }, { authors: { id: $id } }] }
-            options: { limit: 1, skip: $hasNextBlogsSkip, sort: { createdAt: DESC } }
+            options: { limit: 1, offset: $hasNextBlogsOffset, sort: { createdAt: DESC } }
         ) {
             id
         }
     }
 `;
 
 export const RECENTLY_UPDATED_BLOGS = gql`
-    query recentlyUpdatedBlogs($skip: Int, $limit: Int, $hasNextBlogsSkip: Int) {
-        recentlyUpdatedBlogs: blogs(options: { limit: $limit, skip: $skip, sort: { updatedAt: DESC } }) {
+    query recentlyUpdatedBlogs($offset: Int, $limit: Int, $hasNextBlogsOffset: Int) {
+        recentlyUpdatedBlogs: blogs(options: { limit: $limit, offset: $offset, sort: { updatedAt: DESC } }) {
             id
             name
             creator {
@@ -66,7 +66,7 @@ export const RECENTLY_UPDATED_BLOGS = gql`
             }
             updatedAt
         }
-        hasNextBlogs: blogs(options: { limit: 1, skip: $hasNextBlogsSkip, sort: { updatedAt: DESC } }) {
+        hasNextBlogs: blogs(options: { limit: 1, offset: $hasNextBlogsOffset, sort: { updatedAt: DESC } }) {
             id
         }
     }
@@ -155,10 +155,10 @@ export const POST = gql`
 `;
 
 export const BLOG_POSTS = gql`
-    query blogPosts($blog: ID, $skip: Int, $limit: Int, $hasNextPostsSkip: Int) {
+    query blogPosts($blog: ID, $offset: Int, $limit: Int, $hasNextPostsOffset: Int) {
         blogPosts: posts(
             where: { blog: { id: $blog } }
-            options: { skip: $skip, limit: $limit, sort: { createdAt: DESC } }
+            options: { offset: $offset, limit: $limit, sort: { createdAt: DESC } }
         ) {
             id
             title
@@ -169,7 +169,7 @@ export const BLOG_POSTS = gql`
         }
         hasNextPosts: posts(
             where: { blog: { id: $blog } }
-            options: { skip: $hasNextPostsSkip, limit: 1, sort: { createdAt: DESC } }
+            options: { offset: $hasNextPostsOffset, limit: 1, sort: { createdAt: DESC } }
         ) {
             id
         }
@@ -201,10 +201,10 @@ export const COMMENT_ON_POST = gql`
 `;
 
 export const POST_COMMENTS = gql`
-    query postComments($post: ID, $skip: Int, $limit: Int, $hasNextCommentsSkip: Int) {
+    query postComments($post: ID, $offset: Int, $limit: Int, $hasNextCommentsOffset: Int) {
         postComments: comments(
             where: { post: { id: $post } }
-            options: { skip: $skip, limit: $limit, sort: { createdAt: ASC } }
+            options: { offset: $offset, limit: $limit, sort: { createdAt: ASC } }
         ) {
             id
             author {
@@ -217,7 +217,7 @@ export const POST_COMMENTS = gql`
         }
         hasNextComments: comments(
             where: { post: { id: $post } }
-            options: { skip: $hasNextCommentsSkip, limit: 1, sort: { createdAt: ASC } }
+            options: { offset: $hasNextCommentsOffset, limit: 1, sort: { createdAt: ASC } }
         ) {
             id
         }

packages/graphql/src/schema/make-augmented-schema.ts

@@ -97,7 +97,7 @@ function makeAugmentedSchema(
     const queryOptions = composer.createInputTC({
         name: "QueryOptions",
         fields: {
-            skip: "Int",
+            offset: "Int",
             limit: "Int",
         },
     });
@@ -450,13 +450,13 @@ function makeAugmentedSchema(
                         type: sortInput.List,
                     },
                     limit: "Int",
-                    skip: "Int",
+                    offset: "Int",
                 },
             });
         } else {
             composer.createInputTC({
                 name: `${node.name}Options`,
-                fields: { limit: "Int", skip: "Int" },
+                fields: { limit: "Int", offset: "Int" },
             });
         }