8000 DOCSP-48687 - Standardize API Source Constants (#666) (#667) · mongodb/docs-java@5834bc1 · GitHub
[go: up one dir, main page]
Skip to content
< 8000 /div>

Commit 5834bc1

Browse files
github-actions[bot]mongoKart
github-actions[bot]
and
mongoKart
authored
DOCSP-48687 - Standardize API Source Constants (#666) (#667)
(cherry picked from commit 6f002e7) Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com>
1 parent c61f072 commit 5834bc1
  • monitoring.txt
  • references
  • security

    • Some content is hidden

    Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

    71 files changed

    +699
    -698
    lines changed

    ‎snooty.toml

    Lines changed: 3 additions & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -30,8 +30,9 @@ version = "5.4"
    3030
    full-version = "{+version+}.0"
    3131
    mdb-server = "MongoDB Server"
    3232
    package-name-org = "mongodb-org"
    33-
    api = "https://mongodb.github.io/mongo-java-driver/{+version+}"
    34-
    core-api = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-core"
    33+
    api-root = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs"
    34+
    driver-api = "{+api-root+}/mongodb-driver-sync/com/mongodb/client"
    35+
    core-api = "{+api-root+}/mongodb-driver-core/com/mongodb"
    3536
    stable-api = "Stable API"
    3637
    mongocrypt-version = "{+full-version+}"
    3738
    nettyVersion = "io.netty:netty-all:4.1.87.Final"

    ‎source/aggregation.txt

    Lines changed: 1 addition & 1 deletion
    Original file line numberDiff line numberDiff line change
    @@ -74,7 +74,7 @@ Aggregation operations have some :manual:`limitations </core/aggregation-pipelin
    7474
    of 16 megabytes.
    7575

    7676
    - Pipeline stages have a memory limit of 100 megabytes by default. If required, you can exceed this limit by using
    77-
    the `allowDiskUse <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/AggregateIterable.html#allowDiskUse(java.lang.Boolean)>`__
    77+
    the `allowDiskUse <{+driver-api+}/AggregateIterable.html#allowDiskUse(java.lang.Boolean)>`__
    7878
    method.
    7979

    8080
    .. important:: ``$graphLookup`` exception

    ‎source/aggregation/aggregation-examples.txt

    Lines changed: 10 additions & 10 deletions
    Original file line numberDiff line numberDiff line change
    @@ -73,7 +73,7 @@ To perform an aggregation, pass a list of aggregation stages to the
    7373
    ``MongoCollection.aggregate()`` method.
    7474

    7575
    The Java driver provides the
    76-
    `Aggregates <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html>`__
    76+
    `Aggregates <{+core-api+}/client/model/Aggregates.html>`__
    7777
    helper class that contains builders for aggregation stages.
    7878

    7979
    In the following example, the aggregation pipeline:
    @@ -106,8 +106,8 @@ The preceding aggregation produces the following results:
    106106
    For more information about the methods and classes mentioned in this section,
    107107
    see the following API Documentation:
    108108

    109-
    - `MongoCollection.aggregate() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#aggregate(java.util.List)>`__
    110-
    - `Aggregates.match <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#match(org.bson.conversions.Bson)>`__
    109+
    - `MongoCollection.aggregate() <{+driver-api+}/MongoCollection.html#aggregate(java.util.List)>`__
    110+
    - `Aggregates.match <{+core-api+}/client/model/Aggregates.html#match(org.bson.conversions.Bson)>`__
    111111

    112112
    Explain Aggregation Example
    113113
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~
    @@ -161,9 +161,9 @@ following resources:
    161161

    162162
    - :manual:`Explain Output </reference/explain-results/>` Server Manual Entry
    163163
    - :manual:`Query Plans </core/query-plans/>` Server Manual Entry
    164-
    - `ExplainVerbosity <{+api+}/apidocs/mongodb-driver-core/com/mongodb/ExplainVerbosity>`__ API Documentation
    165-
    - `explain() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/FindIterable.html#explain()>`__ API Documentation
    166-
    - `AggregateIterable <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/AggregateIterable.html>`__ API Documentation
    164+
    - `ExplainVerbosity <{+core-api+}/ExplainVerbosity>`__ API Documentation
    165+
    - `explain() <{+driver-api+}/FindIterable.html#explain()>`__ API Documentation
    166+
    - `AggregateIterable <{+driver-api+}/AggregateIterable.html>`__ API Documentation
    167167

    168168
    Aggregation Expression Example
    169169
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    @@ -224,7 +224,7 @@ The preceding aggregation produces the following results:
    224224
    For more information about the methods and classes mentioned in this section,
    225225
    see the following API Documentation:
    226226

    227-
    - `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
    228-
    - `$group <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#group(TExpression,java.util.List)>`__
    229-
    - `$project <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#project(org.bson.conversions.Bson)>`__
    230-
    - `Projections <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Projections.html>`__
    227+
    - `Accumulators <{+core-api+}/client/model/Accumulators.html>`__
    228+
    - `$group <{+core-api+}/client/model/Aggregates.html#group(TExpression,java.util.List)>`__
    229+
    - `$project <{+core-api+}/client/model/Aggregates.html#project(org.bson.conversions.Bson)>`__
    230+
    - `Projections <{+core-api+}/client/model/Projections.html>`__

    ‎source/aggregation/aggregation-expression-operations.txt

    Lines changed: 139 additions & 139 deletions
    Large diffs are not rendered by default.

    ‎source/api-documentation.txt

    Lines changed: 10 additions & 10 deletions
    Original file line numberDiff line numberDiff line change
    @@ -7,26 +7,26 @@ API Documentation
    77
    .. meta::
    88
    :description: Read the API documentation for the {+driver-long+} and related packages.
    99

    10-
    - `BSON <{+api+}/apidocs/bson/index.html>`__ - classes for working with the
    10+
    - `BSON <{+api-root+}/bson/index.html>`__ - classes for working with the
    1111
    BSON data format.
    12-
    - `BSON Record Codec <{+api+}/apidocs/bson-record-codec/index.html>`__ -
    12+
    - `BSON Record Codec <{+api-root+}/bson-record-codec/index.html>`__ -
    1313
    classes for encoding and decoding between Java records and the BSON data
    1414
    format.
    15-
    - `Core <{+api+}/apidocs/mongodb-driver-core/index.html>`__ - classes that
    15+
    - `Core <{+api-root+}/mongodb-driver-core/index.html>`__ - classes that
    1616
    contain essential driver functionality.
    17-
    - `Java Driver (modern API) <{+api+}/apidocs/mongodb-driver-sync/index.html>`__ -
    17+
    - `Java Driver (modern API) <{+api-root+}/mongodb-driver-sync/index.html>`__ -
    1818
    classes for the current driver API.
    19-
    - `Java Driver (legacy API) <{+api+}/apidocs/mongodb-driver-legacy/index.html>`__ -
    19+
    - `Java Driver (legacy API) <{+api-root+}/mongodb-driver-legacy/index.html>`__ -
    2020
    classes that support the legacy driver API. To learn how to upgrade from the
    2121
    legacy API to the modern API from the :ref:`<java-legacy-api>` documentation.
    2222

    2323
    .. toctree::
    2424
    :titlesonly:
    2525
    :maxdepth: 1
    2626

    27-
    BSON <{+api+}/apidocs/bson/index.html>
    28-
    BSON Record Codec <{+api+}/apidocs/bson-record-codec/index.html>
    29-
    Core <{+api+}/apidocs/mongodb-driver-core/index.html>
    30-
    Java Driver (modern API) <{+api+}/apidocs/mongodb-driver-sync/index.html>
    31-
    Java Driver (legacy API) <{+api+}/apidocs/mongodb-driver-legacy/index.html>
    27+
    BSON <{+api-root+}/bson/index.html>
    28+
    BSON Record Codec <{+api-root+}/bson-record-codec/index.html>
    29+
    Core <{+api-root+}/mongodb-driver-core/index.html>
    30+
    Java Driver (modern API) <{+api-root+}/mongodb-driver-sync/index.html>
    31+
    Java Driver (legacy API) <{+api-root+}/mongodb-driver-legacy/index.html>
    3232

    ‎source/atlas-search.txt

    Lines changed: 3 additions & 3 deletions
    Original file line numberDiff line numberDiff line change
    @@ -102,6 +102,6 @@ API Documentation
    102102
    To learn more about the methods mentioned in this guide, see
    103103
    the following API documentation:
    104104

    105-
    - `MongoCollection.aggregate() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#aggregate(java.util.List)>`__
    106-
    - `Aggregates.search() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#search(com.mongodb.client.model.search.SearchCollector)>`__
    107-
    - `Aggregates.project() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#project(org.bson.conversions.Bson)>`__
    105+
    - `MongoCollection.aggregate() <{+driver-api+}/MongoCollection.html#aggregate(java.util.List)>`__
    106+
    - `Aggregates.search() <{+core-api+}/client/model/Aggregates.html#search(com.mongodb.client.model.search.SearchCollector)>`__
    107+
    - `Aggregates.project() <{+core-api+}/client/model/Aggregates.html#project(org.bson.conversions.Bson)>`__

    ‎source/atlas-vector-search.txt

    Lines changed: 5 additions & 5 deletions
    Original file line numberDiff line numberDiff line change
    @@ -93,15 +93,15 @@ To learn more about the methods and types mentioned in this
    9393
    guide, see the following API documentation:
    9494

    9595
    - `Aggregates.vectorSearch()
    96-
    <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#vectorSearch(com.mongodb.client.model.search.FieldSearchPath,java.lang.Iterable,java.lang.String,long,com.mongodb.client.model.search.VectorSearchOptions)>`__
    96+
    <{+core-api+}/client/model/Aggregates.html#vectorSearch(com.mongodb.client.model.search.FieldSearchPath,java.lang.Iterable,java.lang.String,long,com.mongodb.client.model.search.VectorSearchOptions)>`__
    9797

    9898
    - `FieldSearchPath
    99-
    <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/search/FieldSearchPath.html>`__
    99+
    <{+core-api+}/client/model/search/FieldSearchPath.html>`__
    100100

    101101
    - `VectorSearchOptions
    102-
    <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/search/VectorSearchOptions.html>`__
    102+
    <{+core-api+}/client/model/search/VectorSearchOptions.html>`__
    103103

    104104
    - `Projections.metaVectorSearchScore()
    105-
    <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Projections.html#metaVectorSearchScore(java.lang.String)>`__
    105+
    <{+core-api+}/client/model/Projections.html#metaVectorSearchScore(java.lang.String)>`__
    106106

    107-
    - `BinaryVector <{+api+}/apidocs/bson/org/bson/BinaryVector.html>`__
    107+
    - `BinaryVector <{+api-root+}/bson/org/bson/BinaryVector.html>`__

    ‎source/builders/aggregates.txt

    Lines changed: 17 additions & 17 deletions
    Original file line numberDiff line numberDiff line change
    @@ -24,7 +24,7 @@ Aggregates Builders
    2424
    Overview
    2525
    --------
    2626

    27-
    In this guide, you can learn how to use the `Aggregates <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates>`__
    27+
    In this guide, you can learn how to use the `Aggregates <{+core-api+}/client/model/Aggregates>`__
    2828
    class which provides static factory methods that build :manual:`aggregation pipeline
    2929
    stages </meta/aggregation-quick-reference/#stages>` in the MongoDB Java driver.
    3030

    @@ -258,7 +258,7 @@ for each distinct grouping.
    258258

    259259
    .. tip::
    260260

    261-
    The driver includes the `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
    261+
    The driver includes the `Accumulators <{+core-api+}/client/model/Accumulators.html>`__
    262262
    class with static factory methods for each of the supported accumulators.
    263263

    264264
    The following example creates a pipeline stage that groups documents by the value
    @@ -327,7 +327,7 @@ the lowest three ``imdb.rating`` values for movies, grouped by ``year``:
    327327
    :language: java
    328328
    :dedent:
    329329

    330-
    See the `minN() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#minN(java.lang.String,InExpression,NExpression)>`__
    330+
    See the `minN() API documentation <{+core-api+}/client/model/Accumulators.html#minN(java.lang.String,InExpression,NExpression)>`__
    331331
    for more information.
    332332

    333333
    .. _java_aggregates_max_n:
    @@ -347,7 +347,7 @@ return the highest two ``imdb.rating`` values for movies, grouped by ``year``:
    347347
    :language: java
    348348
    :dedent:
    349349

    350-
    See the `maxN() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#maxN(java.lang.String,InExpression,NExpression)>`__
    350+
    See the `maxN() API documentation <{+core-api+}/client/model/Accumulators.html#maxN(java.lang.String,InExpression,NExpression)>`__
    351351
    for more information.
    352352

    353353
    .. _java_aggregates_first_n:
    @@ -375,7 +375,7 @@ into the stage, grouped by ``year``:
    375375
    :language: java
    376376
    :dedent:
    377377

    378-
    See the `firstN() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#firstN(java.lang.String,InExpression,NExpression)>`__
    378+
    See the `firstN() API documentation <{+core-api+}/client/model/Accumulators.html#firstN(java.lang.String,InExpression,NExpression)>`__
    379379
    for more information.
    380380

    381381
    .. _java_aggregates_last_n:
    @@ -396,7 +396,7 @@ the stage, grouped by ``year``:
    396396
    :language: java
    397397
    :dedent:
    398398

    399-
    See the `lastN() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#lastN(java.lang.String,InExpression,NExpression)>`__
    399+
    See the `lastN() API documentation <{+core-api+}/client/model/Accumulators.html#lastN(java.lang.String,InExpression,NExpression)>`__
    400400
    for more information.
    401401

    402402
    .. _java_aggregates_top:
    @@ -417,7 +417,7 @@ the ``title`` and ``imdb.rating`` values for the top rated movies based on the
    417417
    :language: java
    418418
    :dedent:
    419419

    420-
    See the `top() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#top(java.lang.String,org.bson.conversions.Bson,OutExpression)>`__
    420+
    See the `top() API documentation <{+core-api+}/client/model/Accumulators.html#top(java.lang.String,org.bson.conversions.Bson,OutExpression)>`__
    421421
    for more information.
    422422

    423423
    .. _java_aggregates_top_n:
    @@ -445,7 +445,7 @@ the ``title`` and ``runtime`` values of the three longest movies based on the
    445445
    :language: java
    446446
    :dedent:
    447447

    448-
    See the `topN() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#topN(java.lang.String,org.bson.conversions.Bson,OutExpression,NExpression)>`__
    448+
    See the `topN() API documentation <{+core-api+}/client/model/Accumulators.html#topN(java.lang.String,org.bson.conversions.Bson,OutExpression,NExpression)>`__
    449449
    for more information.
    450450

    451451
    .. _java_aggregates_bottom:
    @@ -466,7 +466,7 @@ return the ``title`` and ``runtime`` values of the shortest movie based on the
    466466
    :language: java
    467467
    :dedent:
    468468

    469-
    See the `bottom() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#bottom(java.lang.String,org.bson.conversions.Bson,OutExpression)>`__
    469+
    See the `bottom() API documentation <{+core-api+}/client/model/Accumulators.html#bottom(java.lang.String,org.bson.conversions.Bson,OutExpression)>`__
    470470
    for more information.
    471471

    472472
    .. _java_aggregates_bottom_n:
    @@ -493,7 +493,7 @@ based on the ``imdb.rating`` value, grouped by ``year``:
    493493
    :language: java
    494494
    :dedent:
    495495

    496-
    See the `bottomN() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html#bottomN(java.lang.String,org.bson.conversions.Bson,OutExpression,NExpression)>`__
    496+
    See the `bottomN() API documentation <{+core-api+}/client/model/Accumulators.html#bottomN(java.lang.String,org.bson.conversions.Bson,OutExpression,NExpression)>`__
    497497
    for more information.
    498498

    499499
    Unwind
    @@ -734,7 +734,7 @@ into a bucket called "monster" for monstrously large screen sizes:
    734734

    735735
    .. tip::
    736736

    737-
    The driver includes the `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
    737+
    The driver includes the `Accumulators <{+core-api+}/client/model/Accumulators.html>`__
    738738
    class with static factory methods for each of the supported accumulators.
    739739

    740740
    .. literalinclude:: /includes/fundamentals/code-snippets/builders/AggBuilders.java
    @@ -771,7 +771,7 @@ in a new field called ``avgPrice``:
    771771

    772772
    .. tip::
    773773

    774-
    The driver includes the `Accumulators <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`__
    774+
    The driver includes the `Accumulators <{+core-api+}/client/model/Accumulators.html>`__
    775775
    class with static factory methods for each of the supported accumulators.
    776776

    777777
    .. literalinclude:: /includes/fundamentals/code-snippets/builders/AggBuilders.java
    @@ -811,7 +811,7 @@ on a specified span of documents in a collection.
    811811

    812812
    .. tip:: Window Functions
    813813

    814-
    The driver includes the `Windows <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Windows.html>`__
    814+
    The driver includes the `Windows <{+core-api+}/client/model/Windows.html>`__
    815815
    class with static factory methods for building windowed computations.
    816816

    817817
    The following example creates a pipeline stage that computes the
    @@ -876,7 +876,7 @@ which contain ``ts`` values every 15 minutes between the existing documents:
    876876
    Document{{ position=Document{{coordinates=[-47.9, 47.6]}}, ts=Mon Mar 05 08:45:00 EST 1984 }}
    877877
    Document{{ _id=5553b..., position=Document{{type=Point, coordinates=[-47.9, 47.6]}}, ts=Mon Mar 05 09:00:00 EST 1984, ... }}
    878878

    879-
    See the `densify package API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/densify/package-summary.html>`__
    879+
    See the `densify package API documentation <{+core-api+}/client/model/densify/package-summary.html>`__
    880880
    for more information.
    881881

    882882
    Fill
    @@ -928,7 +928,7 @@ by the aggregate stage:
    928928
    Document{{_id=6308b..., hour=2, temperature=23.5C, air_pressure=29.75}}
    929929
    Document{{_id=6308c..., hour=3, temperature=23.6C, air_pressure=29.76}}
    930930

    931-
    See the `fill package API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/fill/package-summary.html>`__
    931+
    See the `fill package API documentation <{+core-api+}/client/model/fill/package-summary.html>`__
    932932
    for more information.
    933933

    934934
    Atlas Full-Text Search
    @@ -955,7 +955,7 @@ field for text that contains the word "Future":
    955955
    :dedent:
    956956

    957957
    Learn more about the builders from the
    958-
    `search package API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/search/package-summary.html>`__.
    958+
    `search package API documentation <{+core-api+}/client/model/search/package-summary.html>`__.
    959959

    960960
    Atlas Search Metadata
    961961
    ---------------------
    @@ -982,4 +982,4 @@ aggregation stage:
    982982
    :dedent:
    983983

    984984
    Learn more about this helper from the
    985-
    `searchMeta() API documentation <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#searchMeta(com.mongodb.client.model.search.SearchCollector)>`__.
    985+
    `searchMeta() API documentation <{+core-api+}/client/model/Aggregates.html#searchMeta(com.mongodb.client.model.search.SearchCollector)>`__.

    0 commit comments

    Comments
     (0)
    0